Merge pull request #25 from Jesulayomy/hacktoberfest

[Fix]: Requirements for pre-commit, readme .venv update

README.md

@@ -1,8 +1,8 @@
 ![SCHub](./landing_page/images/SCHub-removebg-preview.png)
 
-![GitHub contributors](https://img.shields.io/github/contributors/micoliser/SCHub?style=for-the-badge&labelColor=%2316161a&color=%237F5AF0) ![GitHub last commit (by committer)](https://img.shields.io/github/last-commit/micoliser/SCHub?style=for-the-badge&labelColor=%2316161a&color=%237F5AF0&link=https%3A%2F%2Fgithub.com%2Fmicoliser%2FSCHub%2Fcommits%2Fmain) ![GitHub language count](https://img.shields.io/github/languages/count/micoliser/SCHub?style=for-the-badge&labelColor=%2316161a&color=%237F5AF0) ![GitHub Discussions](https://img.shields.io/github/discussions/micoliser/SCHub?style=for-the-badge&labelColor=%2316161a&color=%237F5AF0) ![GitHub repo size](https://img.shields.io/github/repo-size/micoliser/SCHub?style=for-the-badge&labelColor=%2316161a&color=%237F5AF0)
+![GitHub contributors](https://img.shields.io/github/contributors/jesulayomy/SCHub?style=for-the-badge&labelColor=%2316161a&color=%237F5AF0) ![GitHub last commit (by committer)](https://img.shields.io/github/last-commit/jesulayomy/SCHub?style=for-the-badge&labelColor=%2316161a&color=%237F5AF0&link=https%3A%2F%2Fgithub.com%jesulayomy%2FSCHub%2Fcommits%2Fmain) ![GitHub language count](https://img.shields.io/github/languages/count/jesulayomy/SCHub?style=for-the-badge&labelColor=%2316161a&color=%237F5AF0) ![GitHub Discussions](https://img.shields.io/github/discussions/jesulayomy/SCHub?style=for-the-badge&labelColor=%2316161a&color=%237F5AF0)![GitHub Issues](https://img.shields.io/github/issues/jesulayomy/SCHub?style=for-the-badge&labelColor=%2316161a&color=%237F5AF0)  ![GitHub repo size](https://img.shields.io/github/repo-size/jesulayomy/SCHub?style=for-the-badge&labelColor=%2316161a&color=%237F5AF0) ![Static Badge](https://img.shields.io/badge/Pre--commit-enabled-red?style=for-the-badge&labelColor=16161a&color=2CB67D)
 ---
-![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fschub-api.jesulayomi.tech%2Fapi%2Fstatus&query=status&style=for-the-badge&label=API%20status&labelColor=%2316161a&color=%237F5AF0&link=https%3A%2F%2Fschub-api.jesulayomi.tech%2Fapi%2Fstatus) ![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fschub-api.jesulayomi.tech%2Fapi%2Fstats&query=courses&style=for-the-badge&label=Courses&labelColor=%2316161a&color=%237F5AF0&link=https%3A%2F%2Fschub-api.jesulayomi.tech%2Fapi%2Fstats) ![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fschub-api.jesulayomi.tech%2Fapi%2Fstats&query=students&style=for-the-badge&label=Students&labelColor=%2316161a&color=%237F5AF0&link=https%3A%2F%2Fschub-api.jesulayomi.tech%2Fapi%2Fstats) ![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fschub-api.jesulayomi.tech%2Fapi%2Fstats&query=teachers&style=for-the-badge&label=Teachers&labelColor=%2316161a&color=%237F5AF0&link=https%3A%2F%2Fschub-api.jesulayomi.tech%2Fapi%2Fstats) ![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fschub-api.jesulayomi.tech%2Fapi%2Fstats&query=departments&style=for-the-badge&label=Departments&labelColor=%2316161a&color=%237F5AF0&link=https%3A%2F%2Fschub-api.jesulayomi.tech%2Fapi%2Fstats)
+![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fschub-api.jesulayomi.tech%2Fapi%2Fstatus&query=status&style=for-the-badge&label=API%20status&labelColor=%2316161a&color=%232CB67D&link=https%3A%2F%2Fschub-api.jesulayomi.tech%2Fapi%2Fstatus) ![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fschub-api.jesulayomi.tech%2Fapi%2Fstats&query=courses&style=for-the-badge&label=Courses&labelColor=%2316161a&color=%237F5AF0&link=https%3A%2F%2Fschub-api.jesulayomi.tech%2Fapi%2Fstats) ![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fschub-api.jesulayomi.tech%2Fapi%2Fstats&query=students&style=for-the-badge&label=Students&labelColor=%2316161a&color=%237F5AF0&link=https%3A%2F%2Fschub-api.jesulayomi.tech%2Fapi%2Fstats) ![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fschub-api.jesulayomi.tech%2Fapi%2Fstats&query=teachers&style=for-the-badge&label=Teachers&labelColor=%2316161a&color=%237F5AF0&link=https%3A%2F%2Fschub-api.jesulayomi.tech%2Fapi%2Fstats) ![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fschub-api.jesulayomi.tech%2Fapi%2Fstats&query=departments&style=for-the-badge&label=Departments&labelColor=%2316161a&color=%237F5AF0&link=https%3A%2F%2Fschub-api.jesulayomi.tech%2Fapi%2Fstats)
 
 ---
 
@@ -27,7 +27,9 @@ Clone the repository:
 ```bash
 ~ $ git clone https://github.com/Jesulayomy/SCHub.git
 ~ $ cd SCHub
-/SCHub $
+/SCHub $ python3 -m venv .venv # Create virtual env
+/SCHub $ source .venv/bin/activate # Activate virtual env
+(.venv) /SCHub $ # Keep the virtual env active
 ```
 
 Install Python dependencies with [pip](https://pip.pypa.io/en/stable/), set the environment variables, and mysql database user.

configurations/environment

@@ -7,4 +7,4 @@ DB_TEST_USER = schub_test
 DB_TEST_PASSWORD = {PASSWORD}
 DB_TEST_DB = schub_test_db
 SECRET_KEY = {SECRET_KEY}
-HOST = {schub.example.com OR localhost:8000}
+HOST = {schub.example.com OR 127.0.0.1:8000}

configurations/requirements.txt

@@ -1,13 +1,17 @@
 attrs==23.2.0
 blinker==1.8.2
+cfgv==3.4.0
 click==8.1.7
+distlib==0.3.8
 dnspython==2.6.1
 email-validator==2.0.0.post2
+filelock==3.16.1
 flasgger==0.9.7.1
 Flask==2.3.2
 Flask-Cors==3.0.10
 Flask-Login==0.6.2
 gunicorn==20.1.0
+identify==2.6.1
 idna==3.7
 itsdangerous==2.2.0
 Jinja2==3.1.4
@@ -17,10 +21,13 @@ MarkupSafe==2.1.5
 mistune==3.0.2
 mysql-connector-python==9.0.0
 mysqlclient==2.2.4
+nodeenv==1.9.1
 numpy==2.0.0
 packaging==24.1
 pandas==2.0.2
 pep8==1.7.1
+platformdirs==4.3.6
+pre-commit==3.8.0
 PyJWT==2.7.0
 python-dateutil==2.9.0.post0
 python-dotenv==1.0.1
@@ -33,4 +40,5 @@ six==1.16.0
 SQLAlchemy==2.0.9
 typing_extensions==4.12.2
 tzdata==2024.1
+virtualenv==20.26.6
 Werkzeug==2.3.3