Getting Started

The following is a guide to help you get this repository running.

Setup

Most of the development-related tasks are included in the Makefile (See: Development). To install an environment, with all development packages run:

make install

This command does the following:

  • Install uv if it is not available in the path.

  • Create a virtual environment with all dependencies configured.

  • Install frontend dependencies with bun.

Edit .env configuration

There is a sample .env file located in the root of the repository.

cp .env.local.example .env

Tip

SECRET_KEY, DATABASE_URL, APP_URL, and ALLOWED_CORS_ORIGINS are the most important config settings. Be sure to set them properly.

You can generate a SECRET_KEY by running:

❯ openssl rand -base64 32

+U9UcN0meCsxkShMINkqZ7pcwpEpOC9AwOArZI6mYDU=

Deploy Database Migrations

You can run most of the database commands with the integrated CLI tool.

To deploy migrations to the database, execute:

❯ uv run app database upgrade
2023-06-16T16:55:17.048183Z [info     ] Context impl PostgresqlImpl.
2023-06-16T16:55:17.048251Z [info     ] Will assume transactional DDL.