Go to file
Benjamin Bach 5a8e036dd1
Some checks failed
continuous-integration/drone/pr Build is failing
Update success message
2024-08-01 17:06:04 +02:00
requirements Re-instate updated pip-compile command, regenerate requirements*.txt 2024-08-01 13:04:31 +02:00
src Update success message 2024-08-01 17:06:04 +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 Example API key doesn't need to look like a secret 2024-08-01 12:52:14 +02:00
.gitignore Waiting list function: WaitingListEntry model for people that can be invited in the future 2024-07-14 19:20:32 +02:00
.pre-commit-config.yaml Requirements pinning + some cleanup (#36) 2024-07-31 21:17:00 +00:00
docker-compose.yml Revert healtcheck on Postgres, do it in the entrypoint 2024-07-24 22:29: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 Revert healtcheck on Postgres, do it in the entrypoint 2024-07-24 22:29:07 +02:00
Makefile Merge branch 'main' of git.data.coop:data.coop/membersystem into payment-updates 2024-08-01 00:59:18 +02:00
pyproject.toml Re-instate updated pip-compile command, regenerate requirements*.txt 2024-08-01 13:04:31 +02:00
README.md Clean up README 2024-08-01 12:57:28 +02:00
requirements.txt Re-instate updated pip-compile command, regenerate requirements*.txt 2024-08-01 13:04:31 +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

We use hatch-pip-compile. That means we have a set of loosely defined dependencies in pyproject.toml and then we can keep the exactly pinned version in our requirements.txt (auto-generated).

To generate requirements.txt and requirements/requirements-dev.txt, run the following command:

# Build requirements.txt etc
make requirements

# Build Docker image with new Python requirements
make build