Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/outline/outline

The fastest knowledge base for growing teams. Beautiful, realtime collaborative, feature packed, and markdown compatible.
https://github.com/outline/outline

docker hacktoberfest javascript mobx nodejs react slack wiki

Last synced: 1 day ago
JSON representation

The fastest knowledge base for growing teams. Beautiful, realtime collaborative, feature packed, and markdown compatible.

Awesome Lists containing this project

README 

        


  





  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**](https://www.getoutline.com) 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](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).



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



## 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](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. 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 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](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.



## 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.js` 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.



```shell

# 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:



```shell

yarn sequelize migration:generate --name my-migration

yarn sequelize db:migrate

```



Or to run migrations on test database:



```shell

yarn sequelize db:migrate --env test

```



# Activity



![Alt](https://repobeats.axiom.co/api/embed/ff2e4e6918afff1acf9deb72d1ba6b071d586178.svg "Repobeats analytics image")



# License



Outline is [BSL 1.1 licensed](LICENSE).