Skip to content

Latest commit

 

History

History
195 lines (137 loc) · 5.33 KB

DEVELOPMENT.md

File metadata and controls

195 lines (137 loc) · 5.33 KB
Raw

Development

Polar's stack consist of the following elements:

  • A backend written in Python, exposing a REST API and workers;
  • A frontend written in JavaScript;
  • A PostgreSQL database;
  • A Redis database;
  • A S3-compatible storage.
flowchart TD
    subgraph "Backend"
        API["Rest API"]
        POSTGRESQL["PostgreSQL"]
        REDIS["Redis"]
        S3["S3 Storage"]
        subgraph "Workers"
            WORKER["Generic Worker"]
            GITHUB_WORKER["GitHub Worker"]
        end
    end
    subgraph "Frontend"
        WEB["Web client"]
    end
    GITHUB_WH["GitHub Webhooks"]
    STRIPE_WH["Stripe Webhooks"]
    USERS["Users"]

    WEB --> API
    API --> POSTGRESQL
    API --> REDIS
    REDIS <--> WORKER
    REDIS <--> GITHUB_WORKER
    WORKER --> POSTGRESQL
    GITHUB_WORKER --> POSTGRESQL
    API --> S3
    WEB --> S3

    GITHUB_WH -.-> API
    STRIPE_WH -.-> API
    USERS -.-> API
    USERS -.-> WEB
Loading

Prerequisites

Polar needs a Python 3.12 and Node.js 18 installations.

Setup environment

Tip

Want to get started quickly? Use GitHub Codespaces.

Open in GitHub Codespaces

Setup environment variables

For the Polar stack to run properly, it needs quite a bunch of settings defined as environment variables. To ease things, we provide a script to bootstrap them. It requires uv to be installed on your system.

./dev/setup-environment.py

Once done, the script will automatically create server/.env and clients/apps/web/.env.local files with the necessary environment variables.

Optional: setup GitHub App

If you want to work with GitHub login and issue funding, you'll need to have a GitHub App for your development environment. Our script is able to help in this task by passing the following parameters:

./dev/setup-environment.py --setup-github-app --backend-external-url mydomain.ngrok.dev

Note that you'll need a valid external URL that'll route to your development server. For this task, we recommend to use ngrok.

Your browser will open a new page and you'll be prompted to create a GitHub App. You can just proceed, all the necessary configuration is already done automatically. The script will then add the necessary values to the environment files.

Tip

If you run on GitHub Codespaces, you can just run it like this:

./dev/setup-environment.py --setup-github-app

The script will automatically use your external GitHub Codespace URL.

Optional: setup Stripe

Currently, this setup script doesn't support to create a Stripe Sandbox. If you want a ready-to-use Stripe Sandbox, contact us and we'll happily provide you one.

Setup backend

Tip

If you run on GitHub Codespaces, you can skip this step. This is already done for you.

Setting up the backend consists of basically three things:

1. Start the development containers

This will start PostgreSQL, Redis and Minio (S3 storage) containers. You'll need to have Docker installed.

cd server
docker compose up -d

2. Install Python dependencies

We use Poetry to manage our Python dependencies. Make sure it's installed on your system.

poetry install

Setup frontend

Tip

If you run on GitHub Codespaces, you can skip this step. This is already done for you.

1. Install JavaScript dependencies

We use pnpm to manage our JavaScript dependencies. Make sure it's installed on your system.

cd clients
pnpm install

Start environment

Tip

Use several terminal tabs to run things in parallel.

Start backend

The backend consists of an API server, a general-purpose worker and a worker dedicated to GitHub synchronization. You can run them like this:

cd server

1. Apply the database migrations

poetry run task db_migrate

Note

You don't necessarily need to run it each time you start the server, but it's a good idea to regularly do it nonetheless.

2. Start server and workers

poetry run task api
poetry run task worker
poetry run task worker_github_crawl

Tip

If you don't have to work on issue funding features, you can avoid to run this worker.

By default, the API server will be available at http://127.0.0.1:8000.

Tip

The processes will restart automatically if you make changes to the code.

Start frontend

The frontend mainly consist of a web client server, plus other projects useful for testing or examples. You can run them like this:

cd clients
pnpm run dev

By default, the web client will be available at http://127.0.0.1:3000.

Tip

The processes will restart automatically if you make changes to the code.

Note

On GitHub Codespaces, both API backend and web frontend will be routed on the 8080 port.