CONTRIBUTING.md

   1 # Resources
   2
   3 * [docs](https://www.anuko.com/time_tracker/features.htm) - detailed documentation about this project can be found here (needs updating).
   4 * [forum](https://www.anuko.com/forum/viewforum.php?f=4) - for general discussion.
   5
   6
   7 # Reporting Bugs
   8
   9 * GitHub users: create a [new issue](https://github.com/anuko/timetracker/issues).
  10 * Forum users: use [forum](https://www.anuko.com/forum/viewforum.php?f=4).
  11 * Or, [send 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 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
  24 ```bash
  25 docker-compose up
  26 ```
  27
  28 To use Time Tracker, navigate to: http://localhost:8080. Default credentials for initial login are:
  29 ```
  30 usr: admin
  31 psw: secret
  32 ```
  33
  34 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).