Contents page

• I. What is PurBeurre?
• II. Install
• III. Tests
• IV. To do list
• V. Technologies and ressources

I. What is PurBeurre?

⇧ Top

The aim of this application is to propose a substitute for a food product. The application use the open database provide by the Open Food Facts. This application is made for the project 8 from OpenClassrooms' Python course and reused for the projects 10 and 11.

The application is alive here => https://projet-11.ojardias.io

II. Install and run

⇧ Top

To install this project on your computer you'll need Postgresql, Python 3.9 ans Tox.

First clone this repository:

[email protected]:GuillaumeOj/Pur-Beurre.git
or
https://github.com/GuillaumeOj/Pur-Beurre.git

Configure

In the project directory:

cp env-example .env-local

Edit .env-local and replace parameters by yours:

POSTGRES_DB='your-database-name'
POSTGRES_USER='user-allowed-to-access-the-database'
POSTGRES_HOST='localhost' # Default parameter
POSTGRES_PORT=5432        # Default parameter

Init the database

tox -e init-db

Run the application

tox -e start

Update the application

First update the file for the repository:

git pull

Then use:

tox -e update-app

You're ready to run the application!

III. Tests

⇧ Top

Tests with pytest:

tox -e py39

Test for pep8:

tox -e pep8

Coverage with coverage.py:

tox -e coverage

IV. To do list

⇧ Top

See my Notion's board

V. Technologies and ressources

⇧ Top

This application use various technologies and ressources.

• Main language => Python 3.9
• Framework => Django
• Database => Postgresql
• Front => Bootstrap
• Template => Creative from Start Bootstrap
• Merging PR => Mergify.io
• Tests => Pytest
• Pep8 => Flake8
• Code style => Black
• Import sorting => Isort
• Coverage => Coverage.py and Coveralls
• Continuous Integration => Github Actions
• Hosting => DigitalOcean