Skip to content

Commit

Permalink
task: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
svaponi committed Jul 21, 2024
1 parent 829dfd9 commit 60e80a5
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
[![Test](https://github.com/svaponi/fastapi-mongodb-boilerplate/actions/workflows/run-tests.yml/badge.svg)](https://github.com/svaponi/fastapi-mongodb-boilerplate/actions/workflows/run-tests.yml)
[![Coverage Status](https://coveralls.io/repos/github/svaponi/fastapi-mongodb-boilerplate/badge.svg?branch=main)](https://coveralls.io/github/svaponi/fastapi-mongodb-boilerplate?branch=main)

Boilerplate repository to kickstart 🚀 your [FastAPI](https://fastapi.tiangolo.com/) project.
Boilerplate repository to kickstart 🚀 your [FastAPI](https://fastapi.tiangolo.com/) + [MongoDB](https://www.mongodb.com/) project.

### Key features

- **Non-blocking**, based on [Motor (async driver for MongoDB)](https://www.mongodb.com/docs/drivers/motor/).
- Run [pytest](https://docs.pytest.org/) when you **push changes to `src/` dir** ([GitHub Actions](/.github/workflows/run-tests.yml)).
- [Poetry](https://python-poetry.org/docs/#installation) as **dependency manager** and **packaging tool**.
- [Coveralls](https://docs.coveralls.io/) integration (for coverage badge).
Expand Down

0 comments on commit 60e80a5

Please sign in to comment.