From 597878e8b68948d478f9b3dd8d416b77abba9e96 Mon Sep 17 00:00:00 2001 From: lowercasename Date: Thu, 25 Jul 2019 16:19:09 +0100 Subject: Updated readme --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 33e6cb1..2ebb0ea 100644 --- a/README.md +++ b/README.md @@ -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! -- cgit v1.2.3