Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #7

Merged
merged 1 commit into from
Jan 27, 2024
Merged

Update README.md #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 7 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
[![Maintainability](https://api.codeclimate.com/v1/badges/......)](https://codeclimate.com/repos/....)
-->

![Python: 3.10](https://img.shields.io/badge/python-3.10-informational.svg)
![Python: 3.11](https://img.shields.io/badge/python-3.11-informational.svg)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)
[![mypy: checked](https://img.shields.io/badge/mypy-checked-informational.svg)](http://mypy-lang.org/)
Expand All @@ -25,22 +25,17 @@

### :hammer: Installation

- [Install Docker](https://docs.docker.com/engine/install/) (necessary to run a local MongoDB instance)
- Make sure Python 3.10 is available on your system
- Install [poetry](https://poetry.eustace.io/)
- Setup the environment `./scripts/setup.sh`
- [Install Docker](https://docs.docker.com/engine/install/)
- Build and run: docker-compose up api

### :bulb: Useful scripts

- Start the MongoDB instance `./scripts/start-mongo.sh`
- Stop the MongoDB instance `./scripts/stop-mongo.sh`
- Start the FastAPI server `./scripts/start.sh`
- Format the code `./scripts/format.sh`
- Manually run the linter `./scripts/lint.sh`
- Manually run the tests `./scripts/test.sh`
- Unit tests: docker-compose up unit-tests
- Integration tests: docker-compose up integration-tests
- Linting and other tests: docker-compose up pre-commit

## Coming Soon

- [ ] Articles with details on every single step required to build this app
- [ ] Testing
- [ ] Unit Testing
- [ ] Deployment on AWS with MongoDB Atlas
Loading