Skip to content

Commit be2ba55

Browse files
committed
Add basic instructions for running the db and api services
1 parent c72bb89 commit be2ba55

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

+23
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,13 @@ This will:
3232
```sh
3333
docker compose run --rm app poetry run YOUR_COMMAND
3434
```
35+
3536
## Features and Tests
3637

3738
Behavior driven development (BDD) with [pytest-bdd](https://github.com/pytest-dev/pytest-bdd)
3839

40+
## Behave
41+
3942
Test driven development (TDD) with [pytest](https://docs.pytest.org/)
4043

4144
To run the features located in the ['features'](/features/) directory and tests located in the [`tests`](/tests/) directory, use the following command:
@@ -44,6 +47,26 @@ To run the features located in the ['features'](/features/) directory and tests
4447
docker compose run --rm app poetry run pytest
4548
```
4649

50+
## PostgreSQL database
51+
52+
Some operations and tests rely on a PostgreSQL database that can be run using a separate Docker service.
53+
Use the following command to start up the database.
54+
55+
```sh
56+
docker compose up db
57+
```
58+
59+
## REST API
60+
61+
The application provides a few REST API endpoints for reporting purposes.
62+
Use the following command to start up the server.
63+
API documentation for the routes will be available at [http://0.0.0.0:8000/docs](http://0.0.0.0:8000/docs),
64+
or using a different port if you set the `API_PORT` environment variable to a different value.
65+
66+
```sh
67+
docker compose up api
68+
```
69+
4770
## Generating Samples
4871

4972
To generate sample packages, on the command line run:

0 commit comments

Comments
 (0)