Skip to content

Commit

Permalink
Added dev instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
reinout committed Mar 12, 2024
1 parent 482fe93 commit ac428a6
Showing 1 changed file with 12 additions and 22 deletions.
34 changes: 12 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,35 +18,25 @@ De backend bestaat uit een api met daarin:

## Installatie backend

(Voorlopig moet alles nog zelf lokaal opgezet te worden. Hopelijk wordt een groot deel via docker opgezet in de toekomst, daarom is deze omschrijving nogal beperkt in details)
To install for development:

Om het lokaal te installeren:
$ docker-compose build
$ docker-compose pull
$ pip install pre-commit # Just needed once for your laptop.

1) Clone de repo, maak een venv aan, en installeer de requirements.
It uses a database within docker-compose. TODO: add celery/redis.

2) Maak een database aan
Some instructions:

3) Makemigrations, migrate, createsuperuser
$ docker-compose up # Starts the site on localhost:8000
$ docker-compose run --rm web pytest
$ docker-compose run --rm web python manage.py migrate
$ pre-commit run --all # runs the formatter, checks, etc.

4) Start een redis server lokaal
Do the regular migrate, createsuperuser stuff.

5) start de django applicatie: python manage.py runserver

6) start celery op: celery -A bro_hub worker -l INFO -P solo
TODO: start celery automatically (`celery -A bro_hub worker -l INFO -P solo`)

7) Maak een organisatie, vul de KvK in

8) Maak een user profile aan voor de superuser, en vul het project en evt bro authenticatie in

9) De bro auth gegevens worden geencrypt. Hiervoor is een FIELD_ENCRYPTION_KEY nodig. Om deze aan te maken, run hetvolgende:

$ import os
import base64

new_key = base64.urlsafe_b64encode(os.urandom(32))
print(new_key)

Sla de key (zonder de b'' bytes structuur) op in een .env.


Nu kan het product gebruikt worden.

0 comments on commit ac428a6

Please sign in to comment.