Skip to content

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MegaRedHand committed May 9, 2024
1 parent a9f6a79 commit f5edcad
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -175,4 +175,4 @@ pyrightconfig.json

# End of https://www.toptal.com/developers/gitignore/api/python

sql_app.db
*.db
33 changes: 33 additions & 0 deletions README.md
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.

0 comments on commit f5edcad

Please sign in to comment.