Skip to content

Commit

Permalink
Corrected markdown errors
Browse files Browse the repository at this point in the history
  • Loading branch information
mateowatson committed Sep 12, 2019
1 parent b598edc commit 7bef778
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ It does not require JavaScript to run in the browser, but it has JavaScript spri

## Installing

After cloning the (repo)[https://github.com/mateowatson/timetracker] or downloading a (release)[https://github.com/mateowatson/timetracker/releases], run `composer install` from the project root, assuming you have Composer installed on your computer.
After cloning the [repo](https://github.com/mateowatson/timetracker) or downloading a [release](https://github.com/mateowatson/timetracker/releases), run `composer install` from the project root, assuming you have Composer installed on your computer.

Copy `setup-example.cfg` in the `protected` directory to a file named `setup.cfg` and add the database creds for your SQL instance. It needs just an empty database. Also add site name, site url, and, optionally, timezone and email service features like [Mailgun](https://www.mailgun.com/). The example cfg file has further explanations for each of the variables you can set.

Expand All @@ -16,7 +16,7 @@ Transpile the sass and js code in `public` by running `npm run prod`. We're curr

### Upload to a server

Upload the files to your server except any npm modules directories, .gitignore files, etc. The files in `public` need to be served from your web root, or a subdirectory in web root (**subdirectory installation has not been tested at this time**). The `protected` directory should ideally be placed outside of any publically acessible web directories. If you put it in a directory other than one level up from your public directory or rename it, you will need to change the require statement in `public/index.php` to match. (The name "protected," for what it's worth, comes from the fact that we are (NearlyFreeSpeech.Net)[https://www.nearlyfreespeech.net/] (NFSN) fans, and that is the directory they provide to place files protected from web access.)
Upload the files to your server except any npm modules directories, .gitignore files, etc. The files in `public` need to be served from your web root, or a subdirectory in web root (**subdirectory installation has not been tested at this time**). The `protected` directory should ideally be placed outside of any publically acessible web directories. If you put it in a directory other than one level up from your public directory or rename it, you will need to change the require statement in `public/index.php` to match. (The name "protected," for what it's worth, comes from the fact that we are [NearlyFreeSpeech.Net](https://www.nearlyfreespeech.net/) (NFSN) fans, and that is the directory they provide to place files protected from web access.)

When you go to the website in the browser for the first time, it will prompt you to enter your username, password and optional email, which will be used as the "admin" user, who has the ability to open and close registration, as well as add other users.

Expand Down

0 comments on commit 7bef778

Please sign in to comment.