README.md

Mentorship System (Backend)

Mentorship System is an application that allows women in tech to mentor each other, on career development topics, through 1:1 relations for a certain period. This is the Backend REST API for the Mentorship System.

This API is being used by 3 frontend projects currently being developed:

• android: anitab-org/mentorship-android
• iOS: anitab-org/mentorship-ios
• flutter: anitab-org/mentorship-flutter

Table of Contents

• Setup and run
  • Run app
  • Run with Docker
  • Run tests
• Documentation
• Contributing
• Branches
• Contact
• License

Setup and run

To setup the project locally read these wiki pages and follow the instructions:

• Fork, Clone and Remote
• Export Environment Variables

Run app

The project runs on Python 3.

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

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

source ./venv/bin/activate may produce errors (no such directory errors) for Windows users who use Git Bash, because on Windows machines, virtual environments do not have the bin folder under venv. Instead, run the command source ./venv/Scripts/activate. This command only works on Git Bash on Windows machines. For Windows Command Line Users, run .\env\Scripts\activate instead. This command is for users running the program on Windows CMD.

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

4. Make sure you create .env using .env.template and update the values of corresponding environment variables or make sure you exported the following environment variables:

export FLASK_ENVIRONMENT_CONFIG=<local-or-dev-or-test-or-prod-or-stag>
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>
export MOCK_EMAIL = <True-or-False>

If you're testing any environment other than "local", then you have to also set these other variables:

export DB_TYPE=<database_type>
export DB_USERNAME=<database_username>
export DB_PASSWORD=<database_password>
export DB_ENDPOINT=<database_endpoint>
export DB_NAME=<database_name>

5. Run the app:

python run.py

6. Navigate to http://localhost:5000 in your browser

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

deactivate

Run with docker

1. Make sure you exported the following environment variables to .env file

2. Build docker image

docker build -t mentorship-backend:latest .

3. Deploy Docker container ports must be mapped to the host machine port using '--publish' so they're visible.

docker run --env "FLASK_APP=run.py" --publish 5000:5000 mentorship-backend:latest

Run tests

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

python -m unittest discover tests

Documentation

You can learn more about this project throguh the documentation in the docs folder and on our Wiki.

• Language: Python 3.6
• Framework: Flask
• Flask Extensions: Flask-RESTX, Flask-SQLAlchemy, Flask-JWT-Extended, Flask-Mail

Here are some links to documentation for this project:

• How to use Backend Swagger UI and test PR guide contains a few resources for you to understand how to use the Swagger user interface provided by this app.
• Features Overview has a high level understanding of the features this application has.
• Future ideas for the project.
• Troubleshoot guide contains common isssues other contributors may run into in their setup.
• Quality Assurance test cases has test cases for each endpoint we have which you can use to learn about how each feature should work.
• CI/CD Process which explains the processes and tools involved in deploying new code.

Understand more about our technical decisions made along with this project development in Technical Decisions Wiki page.

Contributing

Please read our Contributing guidelines, Code of Conduct and Reporting Guidelines

Please follow our Commit Message Style Guide and Coding Standards while sending PRs.

Branches

The repository has the following permanent branches:

• master This contains the code which has been released.

• develop This contains the latest code. All the contributing PRs must be sent to this branch. When we want to release the next version of the app, this branch is merged into the master branch. This is the branch that is used in the deployed version of the app on Heroku.

Contact

You can reach the maintainers and our community on AnitaB.org Open Source Zulip. If you are interested in contributing to the mentorship system, we have a dedicated stream for this project #mentorship-system, where you can ask questions and interact with the community, join with us!

License

Mentorship System is licensed under the GNU General Public License v3.0. Learn more about it in the LICENSE file.