Peps helps find personalized agricultural practices to reduce pesticide use.

📱 The repository for Peps' mobile application can be found here.

Start a virtualenv with Python3:

virtualenv -p python3 venv
source ./venv/bin/activate

The requirements are found in requirements.txt. To install them:

pip install -r requirements.txt

You will need a Postgresql database to run the application. You can create one as follows:

psql
CREATE DATABASE peps;

Create an .env file at the same level as the manage.py file. This file should have the following environment values:

PEPS_SECRET='some-secret-value'
PEPS_DEBUG='True'
PEPS_DB_USER='your-pgsql-user'
PEPS_DB_PASSWORD='your-pgsql-password'
PEPS_DB_HOST='127.0.0.1'
PEPS_DB_PORT='5432'
PEPS_DB_NAME='your-db-name'
PEPS_AIRTABLE_KEY='your-airtable-api-key'
PEPS_AIRTABLE_PRACTICES_BASE=xxxxxxxx
PEPS_ALLOWED_HOSTS=127.0.0.1,0.0.0.0
PEPS_MJ_APIKEY_PUBLIC=xxxxxxxx
PEPS_MJ_APIKEY_PRIVATE=xxxxxxxx
PEPS_ASANA_PERSONAL_TOKEN=xxxxxxxx
PEPS_ASANA_PROJECT=xxxxxxxx
PEPS_STATICFILES_STORAGE='django.contrib.staticfiles.storage.StaticFilesStorage'
PEPS_DEFAULT_FILE_STORAGE='peps.pepsfilestorage.PepsFileStorage'
PEPS_CELLAR_HOST=''
PEPS_CELLAR_KEY=''
PEPS_CELLAR_SECRET=''
PEPS_CELLAR_BUCKET_NAME=''
PEPS_FORCE_HTTPS='False'
PEPS_ANALYTICS_ID=''
PEPS_ANALYTICS_DOMAIN=''
PEPS_SECURE='False'
PEPS_HOSTNAME='localhost:8000'
PEPS_EMAIL_BACKEND='django.core.mail.backends.console.EmailBackend'
REDIS_URL='redis://localhost:6379/0'

Before you start, ensure the database is properly migrated:

python manage.py migrate

And create a super user:

python manage.py createsuperuser

You should be ready to go.

To run the tests concerning the current product, simply run:

python manage.py test --exclude-tag=legacy

If you wish to include tests for the legacy product (suggestion engine), you must first fetch the latest data from Airtable:

python manage.py generatetestdata
...
Successfully generated test data

Now you can run the following command to run the entirety of the test suite:

python manage.py test

Legacy engine tests rely on mock data available under api/tests/testdata. To update these files with the latest Airtable data, you can run the following command:

python manage.py generatetestdata

There are two different client-side code locations in this repository:

These are templates and client-side elements that adhere to Django's standard way of doing things. These are currently used for utility views - such as the one showing the weight of the practices in real time.

The views here are not meant to be shown to the final user.

Under frontend we have a VueJS single page application meant to be the main client side web app.

In order to develop and debug this web app we need to launch two development servers: Django's and Vue's.

To launch Django's server:

python manage.py runserver

To launch Vue's server:

cd frontend
npm run serve

This will allow you to have instant reload on both the backend and the frontend.