Skip to content

Latest commit

 

History

History
163 lines (114 loc) · 7.6 KB

README.md

File metadata and controls

163 lines (114 loc) · 7.6 KB
Raw

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:

  • Node.js >= 8.11
  • Postgres >=9.5
  • Redis
  • AWS S3 storage bucket for media and other attachments
  • Slack or Google developer application for authentication

Development

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

  1. Clone this repo
  2. Install Docker for Desktop if you don't already have it
  3. Register a Slack app at https://api.slack.com/apps
  4. Copy the file .env.sample to .env
  5. Fill out the following fields:
    1. SECRET_KEY (follow instructions in the comments of .env)
    2. SLACK_KEY (this is called "Client ID" in Slack admin)
    3. SLACK_SECRET
  6. Add http://localhost:3000/auth/slack.callback as an Oauth callback URL in Slack App settings
  7. Run make up. This will download dependencies, build and launch a development version of Outline

Production

For a self-hosted production installation there is more flexibility, but these are the suggested steps:

  1. Clone this repo and install dependencies with yarn or npm install

    Requires Node.js, npm and yarn installed

  2. Build the web app with yarn build:webpack or npm run build:webpack

  3. Copy the file .env.sample to .env and fill out at least the essential fields:

    1. SECRET_KEY (follow instructions in the comments of .env)
    2. SLACK_KEY (this is called "Client ID" in Slack admin)
    3. SLACK_SECRET
    4. DATABASE_URL (run your own local copy of Postgres, or use a cloud service)
    5. REDIS_URL (run your own local copy of Redis, or use a cloud service)
    6. URL (the public facing URL of your installation)
    7. AWS_ (all of the keys beginning with AWS)

  4. Migrate database schema with yarn sequelize:migrate or npm run sequelize:migrate

  5. Start the service with any daemon tools you prefer. Take PM2 for example, NODE_ENV=production pm2 start index.js --name outline

  6. Visit http://you_server_ip:3000 and you should be able to see Outline page

    Port number can be changed in the .env file

  7. (Optional) You can add an nginx reverse proxy to serve your instance of Outline for a clean URL without the port number, support SSL, etc.

Development

Server

Outline uses debug. To enable debugging output, the following categories are available:

DEBUG=sql,cache,presenters,events,logistics,emails,mailer

Migrations

Sequelize is used to create and run migrations, for example:

yarn sequelize migration:generate --name my-migration
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 the latest language features, including async/await, and Flow typing. Prettier and ESLint are enforced by CI.

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/commands - Domain logic, currently being refactored from /models
  • server/emails - React rendered email templates
  • server/models - Database models
  • server/pages - Server-side rendered public pages
  • server/policies - Authorization logic
  • server/presenters - API responses for database models
  • server/test - Test helps and support
  • server/utils - Utility methods
  • 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.

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 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.