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

updated README

parent 703f99db
Branches
No related tags found
No related merge requests found
......@@ -11,10 +11,24 @@ Allows you to create multiple roadmaps for your projects and displays them in a
- subtasks
- descriptions for each task and subtask
- progress bar for upcoming, currently not finished, milestones
- separated api server and client for rendering the roadmaps
### [Instructions](https://github.com/deadlocker8/roadmap/wiki)
### Installation
_Note: needs a MySQL Database_
### #API Server
1. Set up a fresh PostgreSQL database.
2. Install the API server pipenv `pipenv install`
3. Adjust your settings in `settings.json`
- `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.
#### Client Server (Renders the roadmaps)
1. Install the Client pipenv `pipenv install`
3. Copy `settings-example.json` to `settings.json`
3. Adjust your settings in `settings.json`
- `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).
- `secret` must be filled with a random string to ensure a secure login.
### Screenshots
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment