diff --git a/.gitignore b/.gitignore index 07f447c..b6b4e0f 100644 --- a/.gitignore +++ b/.gitignore @@ -175,4 +175,4 @@ pyrightconfig.json # End of https://www.toptal.com/developers/gitignore/api/python -sql_app.db +*.db diff --git a/README.md b/README.md index 2015f47..d96e67f 100644 --- a/README.md +++ b/README.md @@ -1 +1,34 @@ # Vaquitapp backend + +[![CI](https://github.com/VaquitApp/backend/actions/workflows/python-app.yml/badge.svg)](https://github.com/VaquitApp/backend/actions/workflows/python-app.yml) + +## Dependencies + +- make +- python3.11 +- poetry + +## Installation + +After installing dependencies, run: + +```bash +make install +``` + +## How to run + +Run app locally with: + +```bash +make run +``` + +***Note**: this will also install dependencies with poetry* + +## Development pipeline + +This project uses the *pytest* test suite in the CI pipeline. +To run tests locally, use the command `make test`. + +To format or lint the project, run `make format` or `make lint` respectively.