Skip to content
Snippets Groups Projects
Commit 94dec94c authored by Robert Goldmann's avatar Robert Goldmann
Browse files

updated README

parent e5674827
No related branches found
No related tags found
No related merge requests found
...@@ -18,13 +18,14 @@ Allows you to create multiple roadmaps for your projects and displays them in a ...@@ -18,13 +18,14 @@ Allows you to create multiple roadmaps for your projects and displays them in a
#### API Server #### API Server
1. Set up a fresh PostgreSQL database. 1. Set up a fresh PostgreSQL database.
2. Install the API server pipenv `pipenv install` 2. Install the API server pipenv `pipenv install`
3. Adjust your settings in `settings.json` 3. Copy `settings-example.json` to `settings.json`
4. Adjust your settings in `settings.json`
- `keyfile` and `certfile` in the section `server` must only be filled if `useSSL` is set to `true`. - `keyfile` and `certfile` in the section `server` must only be filled if `useSSL` is set to `true`.
- `secret` must be filled with a random string to ensure a secure login. - `secret` must be filled with a random string to ensure a secure login.
#### Client (Renders the roadmaps) #### Client (Renders the roadmaps)
1. Install the Client pipenv `pipenv install` 1. Install the Client pipenv `pipenv install`
3. Copy `settings-example.json` to `settings.json` 2. Copy `settings-example.json` to `settings.json`
3. Adjust your settings in `settings.json` 3. Adjust your settings in `settings.json`
- `keyfile` and `certfile` must only be filled if `useSSL` is set to `true`. - `keyfile` and `certfile` must only be filled if `useSSL` is set to `true`.
- `apiURL` needs to point ot the url where the API server is running (full url including the port). - `apiURL` needs to point ot the url where the API server is running (full url including the port).
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment