The goal of this project is to help customers who wants to change their diet but were unsure where to start. Replace the Nutella with a hazelnut paste, yes, but which one? In which shop to buy it?

The idea of this application is to provide a handy tool for customers to search, compare foodstuffs or even suggest (healthier) substituts for any.

Copy the .env.example file located in the nested purbeurre directory and rename it .env. You must fill the SECRET_KEY, DATABASE_URL and variables prefixed by ALGOLIA_ otherwise the application will not properly work.

Fill the SECRET_KEY with a long, random string.

Then, in order to be able to run the app, you must install its dependencies which are listed in the requirements.txt file with pip:

$ pip install -r requirements.txt

Finally, you need to create the database which you specify in the .env file and migrate the tables:

$ python manage.py migrate

Sometimes you want to keep libraries from polluting system installs or use a different version of libraries than the ones installed on the system.
For this purpose, the standard library as of Python 3.3 comes with the "venv" module in order to help maintain these separate versions. These are others libraries which do the same but here we'll keep with the standard.

For a more in-depth tutorial, check the Virtual Environments and Packages documentation.

So, lets create our virtual environment:

1. Go to the purbeurre project directory:

   $ cd path/to/purbeurre

2. Create your virtual environment:

   $ python3 -m venv my_venv

3. Activate your virtual environment:

   $ source my_venv/bin/activate

   On Windows it will be a little different:

   $ my_venv\Scripts\activate.bat

   If you use Powershell, the file to use is activate.ps1 instead.

You now have finished setting up your virtual environment.

To exit the virtual environment, simply type the command deactivate in your terminal

After the installation step, you can run the application through the manage.py file in a terminal:

$ python manage.py runserver

The runserver command is only for development purpose