base on # onepixel (1px.li) "onepixel" is an API-first URL shortener. #### Why this name? A URL shortener should have a short domain name, possibly 2 or 3 letter in length. "1 pixel" is the smallest unit of a screen. So `1px.li` stands for `one pixel links` - i.e. smallest possible links :) #### Status Badges [](https://codecov.io/gh/championswimmer/onepixel_backend) [](https://github.com/championswimmer/onepixel_backend/actions/workflows/build_test_release.yaml) ## Hosted Instance (1px.li) The latest version of the code is automatically deployed via [Railway](https://railway.app?referralCode=T4g5xz) to <big><https://onepixel.link></big> You can deploy your own instance too [](https://railway.app/template/xAJ1-J?referralCode=T4g5xz) ## Databases There are two databases used in this project 1. **Application DB** This stores users, shortlinks and link groups 2. **Events/Analytics DB** This stores every redirection event used for analytics and stats #### Production Configuration | Purpose | Database | |----------------|------------------------------------------| | Application DB | [PostgreSQL](https://www.postgresql.org) | | Events DB | [Clickhouse](https://clickhouse.com/) | #### Test Configuration For tests on CI it is better to use small embedded databases instead of spinning up a full database server. | Purpose | Database | |----------------|---------------------------------------------| | Application DB | [SQLite](https://www.sqlite.org/index.html) | | Events DB | [DuckDB](https://duckdb.org/) | > [!NOTE] > You can also override `.onepixel.local.env` to use > the embedded databases for local development > but they are not recommended for production use. ## Development ### Deploy everything (with Docker) Simplest way to get it running is 1. make a `./data` directory where your database will be stored 2. run `docker-compose up` ### Run with hot-reload for local development ### With Docker We will use docker to run an instance of our databases, but we will run the project using [air](https://github.com/cosmtrek/air) locally 1. make the following directories where your database will be stored 1. `./data` for postgres 2. `./clk_data` for clickhouse 3. `./clk_logs` for clickhouse logs 2. run `docker-compose up -d postgres clickhouse` 3. run `air` in the root directory of the project ¹ ### Without Docker We will be using the embedded databases for local development without docker 1. Make the following changes in `.onepixel.local.env` ```env DB_DIALECT=sqlite DATABASE_URL="app.db" USE_FILE_DB=true EVENTS_DB_DIALECT=duckdb EVENTDB_URL="events.db" ``` 2. run `air` in the root directory of the project ¹ > Note[1]: you can also run `go run src/main.go` but it will not reload on changes ", Assign "at most 3 tags" to the expected json: {"id":"4549","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"