Table of Contents
- Clone or fork the repo
- GitHub Desktop: download here
- Clone repo through with git
$ git clone https://github.com/LabConnect-RCOS/LabConnect-Backend.git
- To fork, press the fork button on the top right of the repo, or here
- Install Python 3.12.4 here
- Install Libraries
- Download through the command line
$ python3 -m pip install -r requirements.txt
-
Run pytest
- Run all the test files and generate a coverage report. Coverage reports are setup to output to the terminal and provide an HTML file that can be viewed to show what branches or statements are not covered. It is in the project's best interest to have high coverage to ensure all statements and branches work as expected.
$ make test
or manually
$ python3 -m pytest
or manually with a coverage report generated
$ python3 -m pytest --cov
-
Run flask with python directly
- Run all the test files
$ make develop
or with Makefile
$ python run.py
- TBD, planning to use an RPI VM
- Run gunicorn
or with Makefile
$ make run
$ gunicorn run:app -w 6 --preload --max-requests-jitter 300 --bind 0.0.0.0:8000
Running list of contributors to the LabConnect project:
- Rafael Cenzano [Project Lead]
- Siddhi W [Frontend]
- Mrunal A [Frontend / Backend]
- Abid T [Frontend / Backend]
- Sarah [Backend]
- Ramzey [Backend]
- Will [Frontend]
- Nelson [Backend]
- Duy L [Database Systems]
- Yash K [Frontend]
- Sam B [Scraping / Integration]
We extend our special thanks support and opportunity provided by the RCOS community.
Distributed under the Apache License. See LICENSE for more information.