Update README.md

This commit is contained in:
Jori Lallo
2017-10-30 00:13:05 -07:00
committed by GitHub
parent a1bfde7aec
commit 8b4f8f46a4

View File

@ -2,12 +2,24 @@
![](https://circleci.com/gh/jorilallo/atlas.svg?style=shield&circle-token=c0c4c2f39990e277385d5c1ae96169c409eb887a)
Atlas is a modern wiki for your team build using React and Node.js.
## Installation
Atlas requires following dependencies to work:
- Postgres >=9.5
- Redis
- S3 bucket configured to support CORS uploads
- Slack developer application
To install and run the application:
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 `yarn sequelize -- db:migrate`
- Use `openssl rand -hex 32` to create `SEQUELIZE_SECRET`
1. Run DB migrations `yarn sequelize db:migrate`
1. Start the development server `yarn start`
@ -25,3 +37,8 @@ Or to run migrations on test database:
```
yarn sequelize db:migrate --env test
```
## License
Atlas is [BSD licensed](/blob/master/LICENSE).