Table of Contents
- Clone
- Clone repo through CLI
$ git clone https://github.com/LabConnect-RCOS/LabConnect-Backend.git
- or through Github Desktop
- Install Python 3.12.4 here
- Install Libraries
$ python3 -m pip install -r requirements.txt
-
Run pytest
- Run all the test files and generate a coverage report. Coverage reports are set up 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
$ python run.py
Create PRs to the main branch. Upon merging, a new Docker container will be created and pushed to the packages for this repo.
Use the Docker container in the packages tab. You can set these environment variables:
- SECRET_KEY
- JWT_SECRET_KEY
- FRONTEND_URL
- DB
- Run gunicorn to test how the service runs in production
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]
- Sarah W [Backend]
- Mohammed P [Backend]
- Will B [Frontend]
- Sidarth E [Frontend]
- Sagar S [Frontend]
- Gowrisankar P [Frontend]
- Devan P [Frontend]
- Ramzey Y [Backend] (S'24,F'24)
- Siddhi W [Frontend / Backend] (F'23,S'24,F'24)
- Mrunal A [Frontend / Backend] (F'23,S'24,F'24)
- Abid T [Frontend / Backend] (F'23,S'24)
- Nelson [Backend] (S'24)
- Duy L [Database Systems] (F'23)
- Yash K [Frontend] (F'23)
- Sam B [Scraping / Integration] (F'23)
We extend our special thanks support and opportunity provided by the RCOS community.
Distributed under the Apache License. See LICENSE for more information.