Home

Ugent-4

Welkom bij de UGent-4 wiki!

Team:

Groeps Leider

• Alexandre Paice

Server Admin

• Mathis De Witte

Technical Lead

• Timon Coucke

Klant Communicatie

• Elias Meynckens

Testing

• Arnout Allaert

Backend

• Alexandre Paice
• Mathis De Witte
• Timon Coucke

Frontend

• Ben De Meurichy
• Elias Meynckens
• Gus Vanpoucke
• Alexandre Paice
• Robbe Schildermans

Frontend

Hoe runnen?

Benodigdheden:

• Je zal bepaalde node modules moeten installeren. Dit kan je gemakkelijk doen in één keer. Ga naar de UGent-4/frontend/frontend folder. Run dan het commando npm i.

De frontend lokaal runnen:

Ga naar de UGent-4/frontend/frontend folder. Run het commando: npm run dev. Normaal kan je nu naar de url http://localhost:5173/ surfen in je browser en de frontend zien. Als je een wit scherm ziet dan kan je proberen om de frontend te stoppen, npm audit fix te runnen in dezelfde folder, en de frontend opnieuw te runnen.

Linting:

npm run lint` in de
``` ***frontend/frontend*** directory.

### Testen:

- WIP

# Backend

## Hoe runnen?

### Benodigdheden:
- .env bestand: In deze folder moet je lokaal een .env bestand zetten. Het .env bestand bevat geheime variabelen en codes die je niet in deze repo zal vinden. Vraag het aan iemand van het backend team als je de file wilt krijgen.

- postgres databank: Je zal zelf een postgres databank moeten opzetten. De naam van de databank, user, paswoord, ... Kan je vinden in het .env bestand.

- virtual environment: Je zal ook een virtual environment moeten maken. Doe dit op linux met het commando: `python -m venv /path/to/new/virtual/environment`.
Vervolgens activeer je de virtual environment als volgt: `source my_env/bin/activate`.
Tenslotte installeer je alle dependencies: `pip install -r requirements.txt`.

### de api lokaal runnen:
Om de api lokaal te runnen activeer je eerst de virtual environment. Daarna voer je volgende commando's uit in de UGent-4 directory: 
```sh
./manage.py makemigrations api
./manage.py migrate api
./manage.py runserver

Je kan dan surfen naar http://127.0.0.1:8000/ om de api te zien.

Hoe testen?

OPMERKING: Al de volgende commando's moeten uitgevoerd worden terwijl de virtual environment geactiveerd is.

Je checkt zowel de linting als de tests.

Linting:

flake8 . in de api directory.