2017-11-09 08:03:41 +00:00
# Outline
2016-02-27 21:53:11 +00:00
2017-11-19 09:16:02 +00:00
![](https://circleci.com/gh/outline/outline.svg?style=shield& circle-token=c0c4c2f39990e277385d5c1ae96169c409eb887a)
2017-11-09 16:31:52 +00:00
[![Join the community on Spectrum ](https://withspectrum.github.io/badge/badge.svg )](https://spectrum.chat/outline)
2017-11-26 21:18:14 +00:00
[![code style: prettier ](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square )](https://github.com/prettier/prettier)
2017-07-09 04:19:48 +00:00
2017-11-09 16:31:52 +00:00
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 ](https://www.getoutline.com ) or read on to learn about installing on your own infrastructure.
2017-10-30 07:13:05 +00:00
2017-04-24 03:12:53 +00:00
## Installation
2017-11-09 08:03:41 +00:00
Outline requires following dependencies to work:
2017-10-30 07:13:05 +00:00
- Postgres >=9.5
- Redis
- S3 bucket configured to support CORS uploads
- Slack developer application
To install and run the application:
2017-04-24 03:12:53 +00:00
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
2017-10-30 07:13:05 +00:00
1. Run DB migrations `yarn sequelize db:migrate`
2017-11-10 23:24:29 +00:00
To run Outline in development mode with server and frontend code reloading:
2017-04-24 03:12:53 +00:00
2017-11-10 23:24:29 +00:00
```shell
yarn dev
```
To run Outline in production mode:
```shell
yarn start
```
## Development
### Server
To enable debugging statements, set the following env vars:
```
DEBUG=sql,cache,presenters
```
2017-04-24 03:12:53 +00:00
2017-06-26 00:21:33 +00:00
## Migrations
2016-02-27 21:53:11 +00:00
2017-06-26 00:21:33 +00:00
Sequelize is used to create and run migrations, for example:
```
2017-10-16 01:35:28 +00:00
yarn sequelize migration:create
yarn sequelize db:migrate
2017-06-27 06:33:05 +00:00
```
Or to run migrations on test database:
```
2017-10-16 01:36:22 +00:00
yarn sequelize db:migrate --env test
2017-06-26 00:21:33 +00:00
```
2017-10-30 07:13:05 +00:00
## License
2017-11-09 08:03:41 +00:00
Outline is [BSD licensed ](/blob/master/LICENSE ).