stivenramireza / github-tracker

GitHub tracker as a secure software application.

GitHub Tracker

GitHub tracker is a secure software application which meets some important topics about the cibersecurity like AAA (Authentication, Authorization, Accountability), DevSecOps, Infraestructure as Code (IaC), Single Point of Failure, SQL injection, Cross Site Scripting (XSS), logs, observability, alarms and CORS.

Setup

First of all, you need to install Python 3.12.

Later, you can create a virtual environment and active it in order to install the dependencies only for this project:

$ python3.12 -m venv venv
$ source venv/bin/activate

After that, you must install the dependencies:

pip install --upgrade -r requirements.txt

Now you have an environment to run this application and the automated tests.

Execution

You can run this application with the following command:

$ python main.py

Testing

Some unit tests were implemented in order to validate the GitHub tracker services. You can run them and see the coverage report with the following commands:

$ coverage run -m pytest --verbose
$ coverage report -m