Skip to content

Commit

Permalink
Merge branch 'main' into Forms
Browse files Browse the repository at this point in the history
  • Loading branch information
RafaelCenzano authored Dec 1, 2023
2 parents ec276e9 + b95c50c commit 2073fa4
Show file tree
Hide file tree
Showing 54 changed files with 11,003 additions and 1,017 deletions.
14 changes: 14 additions & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[run]
branch = True
omit = db_test.py

[report]
omit = db_test.py
precision = 2
skip_empty = True
ignore_errors = True

[html]
directory = coverage-reports
skip_empty = True
title = LabConnect Test Coverage Report
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
venv/
env/
*.pyc
*.DS_Store
*.DS_Store
*.db
.coverage
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ develop: clean
python run.py

test: clean
python -m pytest
python -m pytest --cov
83 changes: 78 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![Pull Requst][pr-shield]][pr-url]
[![Apache 2.0 License][license-shield]][license-url]
[![Activity][activity-shield]][activity-url]
[![Stargazers][stars-shield]][stars-url]

Expand Down Expand Up @@ -44,7 +45,12 @@

### Built With

* [![Python][Python.com]][Python-url]
[![Python][Python]][Python-url]
[![HTML][HTML]][HTML-url]
[![CSS][CSS]][CSS-url]
[![JS][JS]][JS-url]
[![Flask][Flask]][Flask-url]
[![Bootstrap][Bootstrap]][Bootstrap-url]


<!-- Getting Started -->
Expand All @@ -65,10 +71,65 @@

## Testing
* Run pytest
* Run all the test files
* 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 that can show what branches or statments are not covered. It is in the projects best interest to have high coverage to ensure all statements and branches work as expected.

```sh
$ make test
```
or manually
```sh
$ python -m pytest
```
or manually with a coverage report generated
```sh
$ python -m pytest --cov
```

## Development
* Run flask with python directly
* Run all the test files

```sh
$ make develop
```
or with Makefile
```sh
$ python run.py
```

## Deployment
* TBD, planning to RPI VM

## Production
* Run gunicorn
```sh
$ make run
```
or with Makefile
```sh
$ gunicorn run:app -w 6 --preload --max-requests-jitter 300
```

## Project Contributors

Running list of contributors to the LabConnect project:

### Project Lead

- **Rafael Cenzano** [Project Lead]

### Rensselaer Center for Open Source Development Team

- **Duy L** [Database Systems]
- **Siddhi W** [UI / UX]
- **Mrunal A** [Frontend / Backend]
- **Yash K** [Frontend]
- **Abid T** [Backend]
- **Sam B** [Scraping / Integration]

### Special Thanks

We extend our special thanks support and opportunity provided by the RCOS community.

## License

Expand All @@ -84,12 +145,24 @@ Distributed under the Apache License. See [LICENSE](https://github.com/RafaelCen
[stars-shield]: https://img.shields.io/github/stars/RafaelCenzano/LabConnect.svg?style=for-the-badge
[stars-url]: https://github.com/RafaelCenzano/LabConnect/stargazers
[issues-shield]: https://img.shields.io/github/issues/RafaelCenzano/LabConnect.svg?style=for-the-badge
[issues-url]: https://github.com/RafaelCenzano/LabConnect/issues
[issues-url]: https://github.com/RafaelCenzano/LabConnect/issues
[pr-shield]: https://img.shields.io/github/issues-pr/RafaelCenzano/LabConnect.svg?style=for-the-badge
[pr-url]: https://github.com/RafaelCenzano/LabConnect/pulls
[license-shield]: https://img.shields.io/github/license/RafaelCenzano/LabConnect.svg?style=for-the-badge
[license-url]: https://github.com/RafaelCenzano/LabConnect/blob/master/LICENSE

[activity-shield]: https://img.shields.io/github/last-commit/RafaelCenzano/LabConnect?style=for-the-badge
[activity-url]: https://github.com/RafaelCenzano/LabConnect/activity

[Python.com]: https://img.shields.io/badge/Python-3776AB.svg?style=for-the-badge&logo=Python&logoColor=white
[Python]: https://img.shields.io/badge/Python-3776AB.svg?style=for-the-badge&logo=Python&logoColor=white
[Python-url]: https://www.python.org/
[HTML]: https://img.shields.io/badge/HTML5-E34F26?style=for-the-badge&logo=html5&logoColor=white
[HTML-url]: https://html.spec.whatwg.org/multipage/
[CSS]: https://img.shields.io/badge/CSS3-1572B6?style=for-the-badge&logo=css3&logoColor=white
[CSS-url]: https://www.w3.org/Style/CSS/Overview.en.html
[JS]: https://img.shields.io/badge/JavaScript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black
[JS-url]: https://www.javascript.com/
[Flask]: https://img.shields.io/badge/Flask-000000?style=for-the-badge&logo=flask&logoColor=white
[Flask-url]: https://flask.palletsprojects.com/en/3.0.x/
[Bootstrap]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
[Bootstrap-url]: https://getbootstrap.com/
Loading

0 comments on commit 2073fa4

Please sign in to comment.