outline/README.md

Atlas

Atlas is a modern wiki for your team build using React and Node.js. https://www.beautifulatlas.com/

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
2. Register a Slack app at https://api.slack.com/apps
3. Copy the file .env.sample to .env and fill out the keys

• Use openssl rand -hex 32 to create SEQUELIZE_SECRET

1. Run DB migrations yarn sequelize db:migrate
2. Start the development server yarn start

Migrations

Sequelize is used to create and run migrations, for example:

yarn sequelize migration:create
yarn sequelize db:migrate

Or to run migrations on test database:

yarn sequelize db:migrate --env test

License

Atlas is BSD licensed.