Skip to content

Commit bb9163b

Browse files
docs: move & expand requirements
refs KK-1379
1 parent f232111 commit bb9163b

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
- [Service architecture](#service-architecture)
1111
- [Environments](#environments)
1212
- [Development](#development)
13+
- [Requirements](#requirements)
1314
- [Development with Docker](#development-with-docker)
1415
- [Development without Docker](#development-without-docker)
1516
- [Installing Python requirements](#installing-python-requirements)
@@ -83,6 +84,17 @@ The notification service environments:
8384

8485
## Development
8586

87+
### Requirements
88+
89+
Compatibility defined by [Dockerfile](./Dockerfile) and [compose.yaml](./compose.yaml):
90+
91+
- PostgreSQL 13
92+
- Python 3.11
93+
94+
Optionally if you want to use pre-commit hooks:
95+
- Node.js 20 for using pre-commit hook's `doctoc`
96+
- Has been tested with Node.js 20, might work with other versions too
97+
8698
### Development with Docker
8799

88100
1. Copy `docker-compose.env.example` to `docker-compose.env` and modify it if needed.
@@ -99,11 +111,7 @@ The project is now running at http://localhost:8081 and using public Keycloak te
99111

100112
### Development without Docker
101113

102-
Prerequisites:
103-
104-
- PostgreSQL 13
105-
- Python 3.11
106-
- Node.js 20 or newer **ONLY** for using pre-commit hook's `doctoc`
114+
Start by installing the [requirements](#requirements).
107115

108116
#### Installing Python requirements
109117

0 commit comments

Comments
 (0)