Skip to content

Latest commit

 

History

History
76 lines (51 loc) · 2.76 KB

README.md

File metadata and controls

76 lines (51 loc) · 2.76 KB
Raw

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

codecov Build and test

Hosted Instance (1px.li)

The latest version of the code is automatically deployed via Railway to
https://onepixel.link

You can deploy your own instance too Deploy on Railway

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
Events DB Clickhouse

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
Events DB DuckDB

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

We will use docker to run an instance of our databases, but we will run the project using 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 1

Note[1]: you can also run go run src/main.go but it will not reload on changes