Skip to content

stankasvecova/redi-run-api

 
 

Repository files navigation

REDI Run Backend

A API written with python + flask. Directly supports REDI Run frontend react app

Docs

This api is fully documented via docs/openapi.yaml, the swagger ui can be found here

Arch

tech arch diagram

Development

Currently @btbtravis is the sole contributer. This information needs to be updated before inviting collaborators

Dev setup requries locally running:

  • MongoDB server, in the future a docker-compose.yml will be provided for this
  • Redis server, in the future a docker-compose.yml will be provided for this
  • Python 3.7+ and pipenv as dependencies in the project are managed via pipenv

So the basic setup would look like this:

$ git clone git@gitlab.com:BTBTravis/redi-run-backend.git
$ cd redi-run-backend
$ cp .env.sample .env

then update .env values

$ pipenv install
$ pipenv shell
$ FLASK_APP=redi-run-app.py flask run -p 5001 --reload

Helpful links for development

About

Python Backend for a student project redi-run

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 96.4%
  • Dockerfile 2.9%
  • Shell 0.7%