UPSTREAMED: outline with this patch integrated: https://github.com/outline/outline/pull/2659
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.
Go to file
Tom Moor 5cccd11d7b Added favicon, social tags to SSR pages 2017-11-09 23:14:03 -08:00
.githooks/pre-commit Run flow on recommit 2017-05-11 17:24:47 -07:00
__mocks__ DocumentsStore WIP 2017-06-27 20:59:53 -07:00
app Merge pull request #389 from jorilallo/ga 2017-11-09 00:50:03 -08:00
flow-typed Fixes #363 2017-10-30 21:45:37 -07:00
public Added favicon, social tags to SSR pages 2017-11-09 23:14:03 -08:00
server Added favicon, social tags to SSR pages 2017-11-09 23:14:03 -08:00
shared Insert ga tags in app 2017-11-09 00:17:55 -08:00
.babelrc Added styled-components table plugin 2017-07-11 22:00:50 -07:00
.env.sample Merge pull request #389 from jorilallo/ga 2017-11-09 00:50:03 -08:00
.eslintrc Moved Bugsnag token into envvar 2017-10-15 16:51:25 -07:00
.flowconfig Sharing global styles 2017-10-26 22:42:08 -07:00
.gitignore Cleaning deployment related stuff 2017-02-09 21:55:36 -08:00
.sequelizerc rm localenv 2017-07-06 23:27:16 -07:00
LICENSE Renamed Atlas to Outline 2017-11-09 00:20:22 -08:00
Procfile Heroic deploy settings 2016-05-22 22:22:14 -07:00
README.md Update README.md 2017-11-09 08:31:52 -08:00
app.json Renamed Atlas to Outline 2017-11-09 00:20:22 -08:00
circle.yml Global error messages (#261) 2017-09-23 18:58:34 -04:00
index.js Moar 2017-07-06 20:59:45 -07:00
init.js Fixes #363 2017-10-30 21:45:37 -07:00
package.json Renamed Atlas to Outline 2017-11-09 00:20:22 -08:00
setupJest.js 💚 ? 2017-07-15 16:08:12 -07:00
webpack.config.dev.js Renamed Atlas to Outline 2017-11-09 00:20:22 -08:00
webpack.config.js Insert ga tags in app 2017-11-09 00:17:55 -08:00
webpack.config.prod.js Insert ga tags in app 2017-11-09 00:17:55 -08:00
yarn.lock Added zooming image and max width fix 2017-11-07 23:10:02 -08:00

README.md

Outline

Join the community on Spectrum

An open, extensible, knowledge base for your team built using React and Node.js. Try Outline out using our hosted version at www.getoutline.com or read on to learn about installing on your own infrastructure.

Installation

Outline 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

Outline is BSD licensed.