Update README.md
This commit is contained in:
19
README.md
19
README.md
@ -2,12 +2,24 @@
|
||||
|
||||

|
||||
|
||||
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).
|
||||
|
Reference in New Issue
Block a user