mirror of
https://github.com/outline/outline.git
synced 2026-05-04 16:50:11 -05:00
Tom Moor
111 lines
5.5 KiB
Markdown
111 lines
5.5 KiB
Markdown
<p align="center">
|
||
<picture>
|
||
<source media="(prefers-color-scheme: dark)" srcset="./public/logos/outline-logo-dark.png" height="29">
|
||
<source media="(prefers-color-scheme: light)" srcset="./public/logos/outline-logo-light.png" height="29">
|
||
<img src="./public/logos/outline-logo-light.png" height="29" alt="Outline" />
|
||
</picture>
|
||
</p>
|
||
<p align="center">
|
||
<i>A fast, collaborative, knowledge base for your team built using React and Node.js.<br/>Try out Outline using our hosted version at <a href="https://www.getoutline.com">www.getoutline.com</a>.</i>
|
||
<br/>
|
||
<img width="1640" alt="screenshot" src="https://user-images.githubusercontent.com/380914/110356468-26374600-7fef-11eb-9f6a-f2cc2c8c6590.png">
|
||
</p>
|
||
<p align="center">
|
||
<a href="http://www.typescriptlang.org" rel="nofollow"><img src="https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg" alt="TypeScript"></a>
|
||
<a href="https://github.com/prettier/prettier"><img src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat" alt="Prettier"></a>
|
||
<a href="https://github.com/styled-components/styled-components"><img src="https://img.shields.io/badge/style-%F0%9F%92%85%20styled--components-orange.svg" alt="Styled Components"></a>
|
||
<a href="https://translate.getoutline.com/project/outline" alt="Localized"><img src="https://badges.crowdin.net/outline/localized.svg"></a>
|
||
</p>
|
||
|
||
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 or contribute to development 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.
|
||
|
||
If you have questions or improvements for the docs please create a thread in [GitHub discussions](https://github.com/outline/outline/discussions).
|
||
|
||
# Contributing
|
||
|
||
> **Note:** Please do not submit AI-generated pull requests. We receive a high volume of mass, low-quality PRs generated by AI tools like Claude, ChatGPT, and Copilot from contributors who are unfamiliar with the codebase. These PRs are almost never mergeable and waste maintainer time reviewing them. If you’d like to contribute, please take the time to understand the codebase and write your changes thoughtfully.
|
||
|
||
Before submitting a pull request _you must_ discuss with the core team by creating or commenting in an issue on [GitHub](https://www.github.com/outline/outline/issues) – we’d also love to hear from you in the [discussions](https://www.github.com/outline/outline/discussions). This way we can ensure that an approach is agreed on before code is written and that you have read these instructions. 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](docs/TRANSLATION.md) into other languages
|
||
- Issues with [`good first issue`](https://github.com/outline/outline/labels/good%20first%20issue) label
|
||
- Performance improvements, both on server and frontend
|
||
- Developer happiness and documentation
|
||
- Bugs, quality fixes, and other issues listed on GitHub
|
||
|
||
# Development
|
||
|
||
There is a short guide for [setting up a development environment](https://docs.getoutline.com/s/hosting/doc/local-development-5hEhFRXow7) if you wish to contribute changes, fixes, and improvements to Outline.
|
||
|
||
## Architecture
|
||
|
||
If you're interested in contributing or 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 [Jest](https://facebook.github.io/jest/) 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 jest:
|
||
|
||
```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
|
||
```
|
||
|
||
# Activity
|
||
|
||
|
||
|
||
# License
|
||
|
||
Outline is [BSL 1.1 licensed](LICENSE).
|