Repository files navigation

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

This is the source code that runsOutline 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 atgetoutline.com. You can also find documentation on using Outline inour guide.

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

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

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

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

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

Before submitting a pull requestplease discuss with the core team by creating or commenting in an issue onGitHub – we'd also love to hear from you in thediscussions. This way we can ensure that an approach is agreed on before code is written. This will result in a much higher likelihood 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 withgood first issue label
• Performance improvements, both on server and frontend
• Developer happiness and documentation
• Bugs and other issues listed on GitHub

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

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 theDEBUG=http environment variable.

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 withJest and add a file with.test.js extension next to the tested code.

# To run all testsmaketest# To run backend tests in watch modemake watch

Once the test database is created withmake test you may individually runfrontend and backend tests directly.

# To run backend testsyarn test:server# To run a specific backend testyarn test:server myTestFile# To run frontend testsyarn test:app

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

yarn sequelize migration:generate --name my-migrationyarn sequelize db:migrate

Or to run migrations on test database:

yarn sequelize db:migrate --envtest

Outline isBSL 1.1 licensed.