Go to file
Benjamin Bach 865bc6c7bd
All checks were successful
continuous-integration/drone/push Build is passing
New WaitingListEntry (#33)
Sorted the pre-commit things... some were because of `src/static` being included, and some have been fixed in another PR 🎉

Reviewed-on: #33
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 22:49:46 +00:00
requirements Update requirements compilation to use hatch-pip-compile. 2024-07-31 23:26:40 +02:00
src New WaitingListEntry (#33) 2024-07-31 22:49:46 +00: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 New WaitingListEntry (#33) 2024-07-31 22:49:46 +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 Update dockerfile to using bookworm, and to avoid invalidating cache unless updating requirements. 2024-07-31 23:48:39 +02:00
entrypoint.sh Fix entrypoint paths. Add uvicorn. Set correct port. 2021-03-01 14:13:19 +01:00
Makefile New WaitingListEntry (#33) 2024-07-31 22:49:46 +00:00
pyproject.toml Update requirements compilation to use hatch-pip-compile. 2024-07-31 23:26:40 +02:00
README.md New WaitingListEntry (#33) 2024-07-31 22:49:46 +00:00
requirements.txt Update requirements compilation to use hatch-pip-compile. 2024-07-31 23:26:40 +02:00

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.

  2. Migrate

    make migrate
    
  3. Run the development server

    make run
    

Building and running other things

# Build the containers
make build

# Create a superuser
make createsuperuser

# Create Django migrations (after this, maybe you need to change file permissions in volume)
make makemigrations

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.

  2. Run migrate

    hatch run dev:migrate
    
  3. Run the development server

    hatch run dev:server
    

Updating requirements

If you want to update the requirements, you can run the following command:

hatch run requirements

This uses hatch-pip-compile to update the requirements.