Kiosk.Backend (Savannah Informatics)

This project was developed as part of an interview evaluation process with Savannah Informatics.

Read The Docs

Swagger

Swagger Documentation Link

Redocs

Redocs Link

PostMan Collection

DataBase Schema

Run Locally

1. create a virtual environement

python3 -m virtualenv venv

2. Activate the virtual environment

source venv/bin/activate

3. Install required dependancies

pip install -r requirements.txt

4. Then run the command below

python3 manage.py runserver

Run with Docker

docker-compose  up --build

Run Tests

pytest tests/ -v

check Code Coverage

coverage run -m pytest

coverage report

sample report

Tools & Technologies

lanuages and Frameworks

• Django Rest (Python) Django REST framework is a powerful and flexible toolkit for building Web APIs with Python 3.7+ based on standard Python.

Testing & Code Coverage

• pytest The pytest framework makes it easy to write small, readable tests, and can scale to support complex functional testing for applications and libraries.
• coverage Coverage measurement is typically used to gauge the effectiveness of tests. It can show which parts of your code are being exercised by tests, and which are not.

CI/CD

• GithubAction GitHub Actions makes it easy to automate all your software workflows, now with world-class CI/CD. Build, test, and deploy your code right from GitHub. Make code reviews, branch management.