Adding installation instructions

This commit is contained in:
Tom Moor 2017-04-23 20:12:53 -07:00
parent 40ae9cd192
commit f705750e88
No known key found for this signature in database
GPG Key ID: 495FE29B5F21BD41
3 changed files with 22 additions and 2 deletions

11
.env.sample Normal file
View File

@ -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

View File

@ -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
- Enable :emoji: autoconvert

View File

@ -52,7 +52,7 @@ export default class Home extends React.Component {
</div>
) }
<div className={ styles.action }>
<SlackAuthLink>
<SlackAuthLink redirectUri={ `${URL}/auth/slack` }>
<img
alt="Sign in with Slack"
height="40"