Rebook

Rebook is a website allowing students to resell school books to each other.

Link to graphical charter

Dev Requirements

• git
• docker
• python
• poetry
• pyenv

Quick start

To setup the developpement instance

./setup

Start the instance

docker compose up -d

In local the project is accessible in http://0.0.0.0:8000 and the admin panel is accessible in http://0.0.0.0:8000/admin

Use Django manager script

To run Django test

docker compose exec rebook python manage.py test

To migrate Django database

docker compose exec rebook python manage.py migrate

To make migration of Django database

docker compose exec rebook python manage.py makemigrations

To create a admin user for the Django app

docker compose exec rebook python manage.py createsuperuser

For install poetry for dev in local

poetry install

To run tests in local

Linter and formater tests :

poetry run pre-commit run -a

Pre-commit

For install pre-commit in your local repository

poetry run pre-commit install

Docker compose

setup script generate a docker compose for developpement purpose. It takes as input the standard docker-compose.yml (same as used in production) and docker-compose-dev-override.

It generates a final docker-compose.yml to be used easily in your on environment.

To modify something inside docker-compose, use the source file and re-run ./setup.sh script.

Environment variables

All environment variables are generated from deploy/env in the docker-compose.yml file by the script ./setup.sh

Naming convention

For branchs

Format of branch name :

<type>/<name of branch>

Availables type :

• feat Add a feature
• fix Fix a bug
• clean Clean the codebase
• refactor Refactor the codebase

For commits

Format of commit messages :

<type>(<scope>): <subject of commit>

Availables type :

• feat Add a feature
• fix Fix a bug
• clean Clean the codebase
• ci Change a file or add feature in link with the deployment of the application (Jenkins, Travis, Ansible, gitlabCI, npm, grunt, gulp, webpack, etc.)
• docs Add documentation (README, JSdoc, comments, etc.)
• refactor Change codebase without add feature or fix bug
• test Add test

For all error with files access

Execute this command if they are some error with files access, because the docker container is running with root user

sudo chown $USER -R rebook/