Cosmetic.
[timetracker.git] / CONTRIBUTING.md
1 # Resources
2
3 * [docs](https://www.anuko.com/time_tracker/features.htm) - detailed documentation about this project (needs updating).
4 * [forum](https://www.anuko.com/forum/viewforum.php?f=4) - general discussion.
5
6
7 # Reporting Bugs
8
9 * GitHub users: create a [new issue](https://github.com/anuko/timetracker/issues) here.
10 * Forum users: post a [new topic](https://www.anuko.com/forum/viewforum.php?f=4 here.
11 * Or, send us a [message](https://www.anuko.com/contact.htm).
12
13
14 # Reporting Security Issues
15
16 * Use the [contact form](https://www.anuko.com/contact.htm) to report a vulnerability.
17 * Or send an encrypted email to security_at_anuko_dot_com. Public key to be published soon.
18
19
20 # Setting up a Dev Environment
21
22 Docker users: install both docker and docker-compose, then run a dev instance:
23 ```bash
24 docker-compose up
25 ```
26 Navigate to: http://localhost:8080 to use Time Tracker. Default credentials for initial login are:
27 ```
28 usr: admin
29 psw: secret
30 ```
31
32 Without docker, perform a manual install of a web server, php, database server, and Time Tracker. Full installation and setup guide can be found [here](https://www.anuko.com/time_tracker/install_guide/index.htm).