/mentorship-backend

Mentorship System is an application that matches women in tech to mentor each other, on career development, through 1:1 relations during a certain period of time. This is the backend of this system.

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

mentorship-backend

Backend REST API for Mentorship System. Depending on branches the following instances of application are running

Branch Server
gsoc18-code Development
develop Staging
master Production

Setup and run

The project runs on Python 3.

  1. Create a virtual environment: virtualenv venv --python=python3

  2. Activate the virtual environment: source ./venv/bin/activate

  3. Install all the dependencies in requirements.txt file: pip install -r requirements.txt

  4. Export the following environment variables:

export FLASK_ENVIRONMENT_CONFIG=<dev-or-test-or-prod>
export SECRET_KEY=<your-secret-key>
export SECURITY_PASSWORD_SALT=<your-security-password-salt>
export MAIL_DEFAULT_SENDER=<mail-default-sender>
export MAIL_SERVER=<mail-server>
export APP_MAIL_USERNAME=<app-mail-username>
export APP_MAIL_PASSWORD=<app-mail-password>

  1. Run the app: python run.py

  2. When you are done using the app, deactivate the virtual environment: deactivate

Run tests

To run the unitests run the following command in the terminal (while the virtual environment is activated):

python -m unittest discover tests