diff options
| author | lowercasename <raphaelkabo@gmail.com> | 2019-07-25 16:19:09 +0100 |
|---|---|---|
| committer | lowercasename <raphaelkabo@gmail.com> | 2019-07-25 16:19:09 +0100 |
| commit | 597878e8b68948d478f9b3dd8d416b77abba9e96 (patch) | |
| tree | bbe7a57a9c0d18a1d9232eae8c611ebdc7d003be | |
| parent | 930542049e40a1a99c9a0c2c349519ccddf52140 (diff) | |
Updated readme
| -rw-r--r-- | README.md | 5 |
1 files changed, 4 insertions, 1 deletions
@@ -6,4 +6,7 @@ You can use the publically hosted version [here](https://gath.io). # Installation -Clone the repository, `npm install`, `npm start`. +1. Clone the repository +2. Open the directory, run `npm install` +3. Rename `config/api-example.js` and `config/database-example.js` to `config/api.js` and `config/database.js`. For locally hosted versions, the local MongoDB configuration will work fine. To send emails, you need to set up a Sendgrid account and get an API key, which you should paste into `config/api.js`. +4. Run `npm start`. Enjoy! |