benjaoming/membersystem
1
0
Fork 0
forked from data.coop/membersystem
Code Issues Pull requests Releases Wiki Activity
membersystem/README.md

1.3 KiB
Raw Blame History

data.coop member system

Development setup

There are two ways to setup the development environment.

  • Using the Docker Compose setup provided in this repository.
  • Using hatch in your host OS.

Using Docker Compose

Working with the Docker Compose setup is made easy with the Makefile provided in the repository.

Requirements

  • Docker
  • docker compose plugin

Setup

  1. Setup .env file

An example .env file is provided in the repository. You can copy it to .env file using the following command:

cp .env.example .env

The default values in the .env file are suitable for the docker-compose setup.

  1. Migrate
make migrate
  1. Run the development server
make run

Using hatch

Requirements

  • Python 3.12 or higher
  • hatch (Recommended way to install is using pipx install hatch)
  • A running PostgreSQL server

Setup

  1. Setup .env file

An example .env file is provided in the repository. You can copy it to .env file using the following command:

cp .env.example .env

Edit the .env file and set the values for the environment variables, especially the database variables.

  1. Run migrate
hatch run dev:migrate
  1. Run the development server
hatch run dev:server