Outline

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 Styled Components

This is the source code that runs [**Outline**](https://www.getoutline.com) and all the associated services. If you want to use Outline then you don't need to run this code, A hosted version of the app is offered at [getoutline.com](https://www.getoutline.com). You can also find documentation on using Outline in [our guide](https://docs.getoutline.com/s/guide). If you'd like to run your own copy of Outline then this is the place for you. # Installation Please see the [documentation](https://docs.getoutline.com/s/hosting/) for running your own copy of Outline in a production configuration. Available container images: * [![Container Image Release](https://img.shields.io/docker/v/outlinewiki/outline?sort=semver&label=Latest%20release)](https://hub.docker.com/r/outlinewiki/outline) * [![Container Image Nightly](https://img.shields.io/docker/v/outlinewiki/outline?sort=date&label=Latest%20development%20version)](https://hub.docker.com/r/outlinewiki/outline) If you have questions or improvements for the docs please create a thread in [GitHub discussions](https://github.com/outline/outline/discussions). # Translation Outline is localized through community contributions on [CrowdIn](https://translate.getoutline.com/project/outline). See the [translation guide](docs/TRANSLATION.md) to help bring Outline to other languages. # Development There is a short guide for [setting up a development environment](https://docs.getoutline.com/s/hosting/doc/local-development-5hEhFRXow7). ## Architecture If you're interested in learning more about the Outline codebase please refer to the [architecture document](docs/ARCHITECTURE.md) 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. logging can be enabled for all categories by setting `DEBUG=*` or for specific categories such as `DEBUG=database` and `LOG_LEVEL=debug`, or `LOG_LEVEL=silly` for very verbose logging. ## 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 [Vitest](https://vitest.dev/) and add a file with `.test.ts` extension next to the tested code. ```shell # 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 with vitest: ```shell # To run backend tests yarn test:server # To run a specific backend test in watch mode yarn test path/to/file.test.ts --watch # To run frontend tests yarn test:app ``` ## Migrations Sequelize is used to create and run migrations, for example: ```shell yarn db:create-migration --name my-migration yarn db:migrate yarn db:rollback ``` Or, to run migrations on test database: ```shell yarn db:migrate --env test ``` # License Outline is [BSL 1.1 licensed](LICENSE).