thattimc / outline Goto Github PK

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

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.

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.

To enable debugging statements, set the following env vars:

DEBUG=sql,cache,presenters,events

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

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.

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 is driven by Slate with several plugins.

• app/ - Frontend React application
• app/scenes - Full page views
• app/components - Reusable React components
• app/components/Editor - Text editor and its plugins
• app/stores - Global state stores
• app/models - State models
• app/types - Flow types for non-models

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

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

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!

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

Outline is BSD licensed.