Local Environment Setup

1. Add database and Mapbox settings to your local environment

From the Terminal, add the following settings to your .bash_profile. Everything you add to the .bash_profile will become part of your local environment.

First, type:

nano ~/.bash_profile

Then paste the following lines into the file, replacing the "..."'s with your own settings (new contributors, Lauren is sending these credentials to you directly).

export DISTR_DB_NAME="..."

export DISTR_DB_USER="..."

export DISTR_DB_PASS="..."

export SECRET_KEY="..."

export MAPBOX_USER_NAME="..."

export DISTR_MAPBOX_KEY="..."

export DJANGO_SETTINGS_MODULE=representable.settings.dev

export SENDGRID_API_KEY="..."

To save these changes, press Ctrl-X then Y. After saving the file, restart the Terminal for the changes to go into effect.

2. Change into your local directory

From Terminal, change into the local directory to where you cloned the Representable codebase locally. For example:

cd representable

3. Install pre-commit

Pre-commit is a framework to make your code prettier and catch any mistakes before you push it to the live codebase.

You can install it as follows on MacOS:

brew install pre-commit

After running the line above, type:

pre-commit install

For non-Mac users, visit the pre-commit website for alternative setup instructions.

4. Create and activate your virtual environment

python3 -m venv venv

. venv/bin/activate

5. Install requirements

pip install -r requirements.txt

For Mac users, you may need to use

brew install graphviz

if you're having trouble with your pygraphviz installation.