From f705750e887bdb6a924db7ba1739daed32b7dc40 Mon Sep 17 00:00:00 2001 From: Tom Moor Date: Sun, 23 Apr 2017 20:12:53 -0700 Subject: [PATCH] Adding installation instructions --- .env.sample | 11 +++++++++++ README.md | 11 ++++++++++- frontend/scenes/Home/Home.js | 2 +- 3 files changed, 22 insertions(+), 2 deletions(-) create mode 100644 .env.sample diff --git a/.env.sample b/.env.sample new file mode 100644 index 00000000..b0c5d109 --- /dev/null +++ b/.env.sample @@ -0,0 +1,11 @@ +# Copy this file to .env, remove this comment and change the keys + +ALLOWED_SLACK_DOMAINS=mytestslackdomain +DATABASE_URL=postgres://user:pass@example.com:5432/atlas +DATABASE_URL_TEST=postgres://user:pass@example.com:5432/atlas-test +PORT=3000 +REDIS_URL=redis://localhost:6379 +SEQUELIZE_SECRET=F0E5AD933D7F6FD8F4DBB3E038C501C052DC0593C686D21ACB30AE205D2F634B +SLACK_KEY=71315967491.XXXXXXXXXX +SLACK_SECRET=d2dc414f9953226bad0a356c794XXXXX +URL=http://localhost:3000 diff --git a/README.md b/README.md index e8d998eb..32c53fbc 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,16 @@ # Atlas +## Installation + + 1. Install dependencies with `yarn` + 1. Register a Slack app at https://api.slack.com/apps + 1. Copy the file `.env.sample` to `.env` and fill out the keys + 1. Run DB migrations `./node_modules/.bin/sequelize db:migrate` + 1. Start the server `yarn start` + + ## Ideas - Create sharable private URLs for notes - Settings - - Enable :emoji: autoconvert \ No newline at end of file + - Enable :emoji: autoconvert diff --git a/frontend/scenes/Home/Home.js b/frontend/scenes/Home/Home.js index 2066f9d8..afba9ba1 100644 --- a/frontend/scenes/Home/Home.js +++ b/frontend/scenes/Home/Home.js @@ -52,7 +52,7 @@ export default class Home extends React.Component { ) }
- +