You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23
Original file line number
Diff line number
Diff line change
@@ -32,10 +32,13 @@ This will:
32
32
```sh
33
33
docker compose run --rm app poetry run YOUR_COMMAND
34
34
```
35
+
35
36
## Features and Tests
36
37
37
38
Behavior driven development (BDD) with [pytest-bdd](https://github.com/pytest-dev/pytest-bdd)
38
39
40
+
## Behave
41
+
39
42
Test driven development (TDD) with [pytest](https://docs.pytest.org/)
40
43
41
44
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
44
47
docker compose run --rm app poetry run pytest
45
48
```
46
49
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
+
47
70
## Generating Samples
48
71
49
72
To generate sample packages, on the command line run:
0 commit comments