Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bjchambers authored Jan 12, 2024
1 parent 5dad286 commit 2c12258
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Knowledge Base Service

# Execute using Docker Compose
## Execute using Docker Compose

```
docker compose up -d --build
Expand All @@ -9,12 +9,12 @@ docker compose up -d --build
Swagger docs at `http://localhost:8000/docs`.
Notebook `example_notebook.ipynb` uses the REST API directly.

# Practices
## Practices

Some skeleton code based on best practices from https://github.com/zhanymkanov/fastapi-best-practices.

In `poetry shell` or using `poetry run ${command}`:

* Linting (and formatting): `ruff check --fix`
* Formatting: `ruff format`
* Type Checking: `mypy app`
* Type Checking: `mypy app`

0 comments on commit 2c12258

Please sign in to comment.