-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a9f6a79
commit f5edcad
Showing
2 changed files
with
34 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -175,4 +175,4 @@ pyrightconfig.json | |
|
||
# End of https://www.toptal.com/developers/gitignore/api/python | ||
|
||
sql_app.db | ||
*.db |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |