📝 Open source wiki and knowledge base for growing teams. Give it a try:
Permalink
Failed to load latest commit information.
.circleci Move to CircleCI 2.0 Jul 28, 2018
.githooks/pre-commit Run flow on recommit May 12, 2017
.github Added welcome bot too :) Feb 11, 2018
__mocks__ DocumentsStore WIP Jun 28, 2017
app `showCollection` option in Dashboard documents list Aug 27, 2018
flow-typed Share Permissions (#761) Aug 19, 2018
public Improved homepage 🙏 Jul 12, 2018
server Types in onboarding doc 🙈 Sep 19, 2018
shared Share Permissions (#761) Aug 19, 2018
.babelrc lint Jan 4, 2018
.env.sample Allowed domains env variable for Google Auth (#682) Jun 16, 2018
.eslintignore Lint rules and flow annotations for rest of the files Nov 16, 2017
.eslintrc lint Jan 4, 2018
.flowconfig Upgrade to Flow 0.71 May 5, 2018
.gitignore service -> serviceId Jun 1, 2018
.sequelizerc rm localenv Jul 7, 2017
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Feb 19, 2018
Dockerfile Move PATH and NODE_ENV under Dockerfile. Fixes problem with PATH in Aug 14, 2018
LICENSE Renamed Atlas to Outline Nov 9, 2017
Makefile Added delete endpoint May 13, 2018
Procfile Heroic deploy settings May 23, 2016
README.md [ci skip] Added roadmap Jun 23, 2018
docker-compose.yml Move PATH and NODE_ENV under Dockerfile. Fixes problem with PATH in Aug 14, 2018
index.js Prevent signin without hosted domain May 29, 2018
init.js Fixes #363 Oct 31, 2017
package.json Bump RME. Closes #771 Sep 11, 2018
setupJest.js Upgrade to Flow 0.71 May 5, 2018
webpack.config.dev.js Added link=“prefetch” tags Jan 22, 2018
webpack.config.js Merge ErrorsStore into UiStore May 31, 2018
webpack.config.prod.js Fixes build by updating Uglify May 12, 2018
yarn.lock Bump RME. Closes #771 Sep 11, 2018

README.md

An open, extensible, wiki for your team built using React and Node.js.
Try out Outline using our hosted version at www.getoutline.com.

Outline

Join the community on Spectrum

This is the source code that runs Outline and all the associated services. If you want to use Outline then you don't need to run this code, we offer a hosted version of the app at getoutline.com.

If you'd like to run your own copy of Outline or contribute to development then this is the place for you.

Installation

Outline requires the following dependencies:

  • Postgres >=9.5
  • Redis
  • Slack developer application

In development you can quickly get an environment running using Docker by following these steps:

  1. Install Docker for Desktop if you don't already have it.
  2. Register a Slack app at https://api.slack.com/apps
  3. Copy the file .env.sample to .env and fill out the Slack keys, everything else should work well for development.
  4. Run make up. This will download dependencies, build and launch a development version of Outline.

Development

Server

To enable debugging statements, set the following env vars:

DEBUG=sql,cache,presenters,events

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

Structure

Outline is composed of separate backend and frontend application which are both driven by the same Node process. As both are written in Javascript, they share some code but are mostly separate. We utilize latest language features, including async/await, and Flow typing. Prettier and ESLint are ran as pre-commit hooks.

Frontend

Outline's frontend is a React application compiled with Webpack. It uses Mobx for state management and Styled Components for component styles. Unless global, state logic and styles are always co-located with React components together with their subcomponents to make the component tree easier to manage.

The editor itself is built ontop of Slate and hosted in a separate repository to encourage reuse: rich-markdown-editor

  • app/ - Frontend React application
  • app/scenes - Full page views
  • app/components - Reusable React components
  • app/stores - Global state stores
  • app/models - State models
  • app/types - Flow types for non-models

Backend

Backend is driven by Koa (API, web server), Sequelize (database) and React for public pages and emails.

  • server/api - API endpoints
  • server/emails - React rendered email templates
  • server/models - Database models (Sequelize)
  • server/pages - Server-side rendered public pages (React)
  • server/presenters - API responses for database models
  • shared - Code shared between frontend and backend applications

Tests

We aim to have sufficient test coverage for critical parts of the application and aren't aiming for 100% unit test coverage. All API endpoints and anything authentication related should be thoroughly tested, and it's generally good to add tests for backend features and code.

To add new tests, write your tests with Jest and add a file with .test.js extension next to the tested code.

# To run all tests
yarn test

# To run backend tests
yarn test:server

# To run frontend tests
yarn test:app

Contributing

Outline is still built and maintained by a small team – we'd love your help to fix bugs and add features!

However, before working on a pull request please let the core team know by creating or commenting in an issue on GitHub, and we'd also love to hear from you in our Spectrum community. This way we can ensure that an approach is agreed on before code is written and will hopefully help to get your contributions integrated faster! Take a look at our roadmap.

If you’re looking for ways to get started, here's a list of ways to help us improve Outline:

  • Issues with good first issue label
  • Performance improvements, both on server and frontend
  • Developer happiness and documentation
  • Bugs and other issues listed on GitHub
  • Helping others on Spectrum

License

Outline is BSD licensed.