search

KnightHacks / hackathon-2021-backend

The backend api for Knight Hacks.
https://api.knighthacks.org/apidocs/
MIT License
3 stars 3 forks source link

readme

Knight Hacks 2021 Backend

Backend server for Knight Hacks '21

Contents

QuickStart

Requirements:

  1. Install the requirements. It is suggested that you use a Python virtual environment.

pip install -r requirements.txt

  1. Run the server

python -m src run --port=5000

  1. Access Swagger API Documentation

Type localhost:5000/apidocs in your browser

Backend Environment Variables

These are the default values, feel free to change them.

APP_SETTINGS=src.config.ProductionConfig
MONGO_URI=mongo://localhost:27017/test

Testing

  1. Install the dev requirements.

pip install -r requirements-dev.txt

  1. Run the tests

python -m src test

Contributing

For guidance on setting up a development environment and how to make a contribution, see the contributing guidelines

Links