Skip to content

Commit d009566

Browse files
committed
Improved doc
1 parent 539d4d9 commit d009566

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

services/api-server/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# api-server
22

33
[![image-size]](https://microbadger.com/images/itisfoundation/api-server. "More on itisfoundation/api-server.:staging-latest image")
4-
54
[![image-badge]](https://microbadger.com/images/itisfoundation/api-server "More on Public API Server image in registry")
65
[![image-version]](https://microbadger.com/images/itisfoundation/api-server "More on Public API Server image in registry")
76
[![image-commit]](https://microbadger.com/images/itisfoundation/api-server "More on Public API Server image in registry")
@@ -25,11 +24,12 @@ source .venv/bin/activate
2524
cd services/api-service
2625
make install-dev
2726
```
28-
To run a dev server just
27+
Then
2928
```cmd
3029
make run-devel
3130
```
32-
and the following sites are available
31+
32+
will start the api-server in development-mode together with a postgres db initialized with test data. Open the following sites and use the test credentials ``user=key, password=secret`` to manually test the API:
3333

3434
- http://127.0.0.1:8000/docs: redoc documentation
3535
- http://127.0.0.1:8000/dev/docs: swagger type of documentation

0 commit comments

Comments
 (0)