UPSTREAMED: outline with this patch integrated: https://github.com/outline/outline/pull/2659
7d756e4fae
|
||
|---|---|---|
| .githooks/pre-commit | ||
| __mocks__ | ||
| app | ||
| flow-typed | ||
| public | ||
| server | ||
| shared | ||
| .babelrc | ||
| .env.sample | ||
| .eslintignore | ||
| .eslintrc | ||
| .flowconfig | ||
| .gitignore | ||
| .sequelizerc | ||
| CHANGELOG.md | ||
| Dockerfile | ||
| LICENSE | ||
| Makefile | ||
| Procfile | ||
| README.md | ||
| circle.yml | ||
| docker-compose.yml | ||
| index.js | ||
| init.js | ||
| package.json | ||
| setupJest.js | ||
| webpack.config.dev.js | ||
| webpack.config.js | ||
| webpack.config.prod.js | ||
| yarn.lock | ||
README.md
Outline
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 the following dependencies:
- Postgres >=9.5
- Redis
- Slack developer application
In development you can quickly can an environment running using Docker by following these steps:
- Install Docker for Desktop if you don't already have it.
- Register a Slack app at https://api.slack.com/apps
- Copy the file
.env.sampleto.envand fill out the Slack keys, everything else should work well for development. - Run
make up. This will download dependencies, build and launch a development version of Outline.
Development
Server
To enable debugging statements, add the following to your .env file:
DEBUG=sql,cache,presenters
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.