This repository has been archived on 2022-08-14. You can view files and clone it, but cannot push or open issues or pull requests.
outline/README.md

1011 B

Atlas

Atlas is a modern wiki for your team built 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
  4. Run DB migrations yarn sequelize db:migrate
  5. 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.