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: server/README.md
+11-2Lines changed: 11 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
4
4
## Installation
5
5
6
-
This package just requires `poetry` to be installed on your system, so all the dependencies are managed by it. Go to the `server/` directory in the project and run the following commands:
6
+
This package just requires `poetry` to be installed on your system, so all the dependencies are managed by it. Go to the `server/` directory in the project and run the following commands:
7
7
8
8
```bash
9
9
$ poetry install
@@ -17,4 +17,13 @@ Then you can access the server via this URL: http://127.0.0.1:8000
17
17
18
18
To access the HTML view for the API schema, just run the server and follow the `/#docs` endpoint.
19
19
20
-
For getting its JSON version, follow the `/openapi.json` endpoint.
20
+
For getting its JSON version, follow the `/openapi.json` endpoint. You can also retrieve the schema in the YAML format by following the `/openapi.yaml` endpoint ior just reading the `openapi.yaml` file in the repo.
21
+
22
+
23
+
## Development
24
+
25
+
### Pre-commit hooks
26
+
27
+
The repo contains pre-commit hook rules to update the openapi.yaml file before committing the changes. To use it, first install `pre-commit` on your system by running `pip install pre-commit`.
28
+
29
+
Then go to the project root directory and run `pre-commit install`.
0 commit comments