Giter Club home page Giter Club logo

onepixel_backend's Introduction

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

onepixel_backend's People

Contributors

championswimmer avatar akshat2602 avatar martinyonatann avatar aqsaaqeel avatar atmnk avatar faiz-swiggy avatar faizbshah avatar glokta1 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.