You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Tom Moor 19de348c85 fix: null ref usage, closes #3456 20 hours ago
.circleci Update config.yml 1 month ago
.github fix: Tweak commit message for calibre action to be semantic 1 month ago
.husky chore: Move i18n generation, pre-commit hooks (#3410) 4 weeks ago
.vscode chore: Move to Typescript (#2783) 6 months ago
__mocks__ fix: Detect Pomerium proxy (#3219) 2 months ago
app fix: null ref usage, closes #3456 20 hours ago
docs docs 1 month ago
public chore: Compressed inefficient images automatically (#3443) 3 weeks ago
server chore: utils.gc -> cron.daily (#3543) 22 hours ago
shared fix: Focus submit button by default in confirmation dialogs 2 days ago
.babelrc fix: No reserving space in sidebar for overflow (#2807) 6 months ago
.dockerignore fix: Keep tsconfig.json in Docker build (#2823) 5 months ago
.env.sample feat: make ioredis configurable via environment variables (#3365) 2 weeks ago
.eslintignore Lint rules and flow annotations for rest of the files 5 years ago
.eslintrc fix: Use of lookbehind regex crashes Safari, added lint rule to prevent future accidental regression 1 month ago
.gitignore feat: Support SSL without reverse proxy (#2959) 4 months ago
.sequelizerc rm localenv 5 years ago
Dockerfile feat: add arm64 docker image build (#3262) 1 month ago
Dockerfile.base feat: add arm64 docker image build (#3262) 1 month ago
LICENSE Update LICENSE 1 month ago
Makefile Collaborative editing (#1660) 8 months ago
Procfile fix: Optimizing Heroku deployment: more configs, add collaboration support (#2838) 5 months ago
README.md docs: Update README to point to new docs 4 months ago
app.json fix: Optimizing Heroku deployment: more configs, add collaboration support (#2838) 5 months ago
crowdin.yml Update crowdin.yml 1 year ago
docker-compose.yml feat: make ioredis configurable via environment variables (#3365) 2 weeks ago
i18next-parser.config.js chore: Move i18n generation, pre-commit hooks (#3410) 4 weeks ago
lint-staged.config.mjs chore: Move i18n generation, pre-commit hooks (#3410) 4 weeks ago
package.json chore: Refactor data import (#3434) 3 weeks ago
tsconfig.json feat: Show drafts in sidebar when viewing (#2820) 5 months ago
webpack.config.dev.js chore: Faster source map in dev 1 year ago
webpack.config.js chore: new arrow key navigation (#3229) 2 months ago
webpack.config.prod.js fix: Restore DNS prefetching for static resources (#1820) 1 year ago
yarn.lock chore: Update caniuse browser support 2 weeks ago

README.md

A fast, collaborative, knowledge base for your team built using React and Node.js.
Try out Outline using our hosted version at www.getoutline.com.

screenshot

TypeScript Prettier Styled Components

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

Please see the documentation for running your own copy of Outline in a production configuration.

If you have questions or improvements for the docs please create a thread in GitHub discussions.

Development

There is a short guide for setting up a development environment if you wish to contribute changes, fixes, and improvements to Outline.

Contributing

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

Before submitting a pull request please discuss with the core team by creating or commenting in an issue on GitHub – we'd also love to hear from you in the discussions. This way we can ensure that an approach is agreed on before code is written. This will result in a much higher liklihood of your code being accepted.

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

  • Translation into other languages
  • Issues with good first issue label
  • Performance improvements, both on server and frontend
  • Developer happiness and documentation
  • Bugs and other issues listed on GitHub

Architecture

If you're interested in contributing or learning more about the Outline codebase please refer to the architecture document first for a high level overview of how the application is put together.

Debugging

In development Outline outputs simple logging to the console, prefixed by categories. In production it outputs JSON logs, these can be easily parsed by your preferred log ingestion pipeline.

HTTP logging is disabled by default, but can be enabled by setting the DEBUG=http environment variable.

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
make test

# To run backend tests in watch mode
make watch

Once the test database is created with make test you may individually run frontend and backend tests directly.

# To run backend tests
yarn test:server

# To run a specific backend test
yarn test:server myTestFile

# To run frontend tests
yarn test:app

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

License

Outline is BSL 1.1 licensed.