Create CONTRIBUTING.md (#73)
[timetracker.git] / CONTRIBUTING.md
1 # Short Links to Important Resources
2
3 * [docs](https://www.anuko.com/time_tracker/features.htm) - detailed documentation about this project can be found here
4 * [bugs](https://github.com/anuko/timetracker/issues) - report bugs and issues here
5 * [forum](https://www.anuko.com/forum/viewforum.php?f=4) - for general discussion
6
7 # Reporting Bugs
8
9 Create a [new issue](https://github.com/anuko/timetracker/issues). 
10
11 # Reporting Security Issues
12
13 **#TODO**
14
15 # Setting up a dev environment
16
17 Use docker to run dev instance:
18 ```bash
19 docker-compose up
20 ```
21
22 and then navigate to: http://localhost:8080. Default credentials for initial login are: 
23 ```
24 usr: admin
25 psw: secret
26 ```
27
28 Full installation and setup guide can be found [here](https://www.anuko.com/time_tracker/install_guide/index.htm).