♥️ Monod Crush

Website is available at monodcrush.fr
NSI project realized by @BenoitObelia, @JulesGrd and @KillianTib

📥 Install

Windows and inux

Clone the repository

git clone https://github.com/BenoitObelia/Monod-Crush
cd Monod-Crush

Create a virtualenv and activate it (optional)

virtualenv venv
venv/Scripts/activate # for Windows
source venv/bin/activate # for Linux

Install dependencies

pip install -r requirements.txt

or for development

pip install -r requirements-dev.txt

🧰 Usage

For development

don't forget to activate the virtual environment if you have it installed

1) setup environment variables

Linux :

export FLASK_APP=flaskr
export FLASK_ENV=development

Windows (CMD) :

set FLASK_APP=flaskr
set FLASK_ENV=development

Windows (PowerShell) :

$env:FLASK_APP="flaskr"
$env:FLASK_ENV="development"

2) Setup database

flask init-db

You can populate the database with some data with the following command

flask populate-db

3) Run the server

Local :

flask run

LAN (/!\ Do not use it in a production deployment) :

flask run --host=0.0.0.0

Then open http://localhost:5000/

⚒️ Test

Run with coverage report

coverage run -m pytest
coverage report
coverage html  # open htmlcov/index.html in a browser

✅ For production

use gunicorn with a reverse proxy server like Nginx