GuillaumeOj / P13-WOD-Board

Last project for my OpenClassrooms' path : https://openclassrooms.com/fr/paths/322-developpeur-dapplication-python

Presentation

This application is for the project 13 from OpenClassrooms' Python course.

The application is alive here => http://projet-13.ojardias.io

The roadmap of this project is available here: Notion

Requirements

For running this application you will need:

• Python 3.9
• Tox
• PostgreSQL
• Yarn 1.22

Setup PostgreSQL with those parameters:

• User: your choice
• Password: your choice too
• Databases:
  • wod_board_test (used for tests)
  • wod_board_dev (used for running the application)

Env

Create a .env file in /backend based on /backend/env-example.

NOTE: Don't forget to replace user and password in DATABASE_URL

Run

Start the backend application:

cd /backend
tox -e seed  # Populate the databe with user accounts and basic items
tox -e start # Run the backend application

Then visit:

• http://localhost:8500/api/docs for reading the back-end documentation

Start the frontend:

cd /frontend
yarn install # Only the first time
yarn start

Then visit:

• http://localhost:3000/

Tests

In /backend type:

tox -e py39 [-- {optional-args}] # For python tests
tox -e pep8                      # For pep8