File tree Expand file tree Collapse file tree 1 file changed +13
-5
lines changed Expand file tree Collapse file tree 1 file changed +13
-5
lines changed Original file line number Diff line number Diff line change 10
10
- [ Service architecture] ( #service-architecture )
11
11
- [ Environments] ( #environments )
12
12
- [ Development] ( #development )
13
+ - [ Requirements] ( #requirements )
13
14
- [ Development with Docker] ( #development-with-docker )
14
15
- [ Development without Docker] ( #development-without-docker )
15
16
- [ Installing Python requirements] ( #installing-python-requirements )
@@ -83,6 +84,17 @@ The notification service environments:
83
84
84
85
## Development
85
86
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
+
86
98
### Development with Docker
87
99
88
100
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
99
111
100
112
### Development without Docker
101
113
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 ) .
107
115
108
116
#### Installing Python requirements
109
117
You can’t perform that action at this time.
0 commit comments