Skip to content

Commit

Permalink
feat: Add Poetry configuration and usage instructions in README
Browse files Browse the repository at this point in the history
  • Loading branch information
jmcerrejon committed Nov 14, 2024
1 parent a926884 commit e7b632b
Show file tree
Hide file tree
Showing 3 changed files with 627 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,34 @@ To run the tests, run the following command:
PYTHONPATH=. pytest tests/units
```

## Using Poetry

To install and use Poetry in the project, follow these steps:

1. Install Poetry:

```bash
pip install poetry
```

2. Install the dependencies using Poetry:

```bash
poetry install
```

3. To add a new dependency, use the following command:

```bash
poetry add <package_name>
```

4. To run the project using Poetry, use the following command:

```bash
poetry run uvicorn main:app --host 127.0.0.1 --port 8000 --reload
```

## TODO

- [x] Add Database support (default: sqlite).
Expand Down
Loading

0 comments on commit e7b632b

Please sign in to comment.