benjaoming/membersystem
1
0
Fork 0
forked from data.coop/membersystem
Code Issues Pull requests Releases Wiki Activity
128 commits 12 branches 0 tags 30 MiB
Python 77.3%
HTML 19.8%
CSS 2.1%
Makefile 0.8%
Go to file
Benjamin Bach f6d8f82065 Requirements pinning + some cleanup (#36) 
Reviewed-on: data.coop/membersystem#36
Reviewed-by: valberg <valberg@orn.li>
Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
Co-committed-by: Benjamin Bach <benjamin@overtag.dk>
2024-07-31 21:17:00 +00:00
requirements Requirements pinning + some cleanup (#36) 2024-07-31 21:17:00 +00:00
src The ruffening. 2024-07-15 00:19:37 +02:00
.dockerignore Cleanup. 2024-07-14 23:14:07 +02:00
.drone.yml Cleanup. 2024-07-14 23:14:07 +02:00
.env.example Cleanup. 2024-07-14 23:14:07 +02:00
.gitignore ui-overhaul (#24) 2024-01-13 20:07:36 +00:00
.pre-commit-config.yaml Requirements pinning + some cleanup (#36) 2024-07-31 21:17:00 +00:00
docker-compose.yml Cleanup. 2024-07-14 23:14:07 +02:00
Dockerfile Shorten and document Docker tweaks for Python and pip (#35) 2024-07-23 22:48:24 +00:00
entrypoint.sh Fix entrypoint paths. Add uvicorn. Set correct port. 2021-03-01 14:13:19 +01:00
Makefile Cleanup. 2024-07-14 23:14:07 +02:00
pyproject.toml Requirements pinning + some cleanup (#36) 2024-07-31 21:17:00 +00:00
README.md Cleanup. 2024-07-14 23:14:07 +02:00
requirements.txt Requirements pinning + some cleanup (#36) 2024-07-31 21:17:00 +00:00

README.md

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