outline

Быстрая база знаний для совместной работы для вашей команды, созданная с использованием React и Node.js.
Попробуйте Outline, используя нашу размещенную версию на www.getoutline.com.

Это исходный код, который запускает Outline и все связанные службы. Если вы хотите использовать Outline, вам не нужно запускать этот код: мы предлагаем размещенную версию приложения на getoutline.com. Вы также можете найти документацию по использованию Outline в нашем руководстве.

Если вы хотите запустить собственную копию Outline или внести свой вклад в разработку, это место для вас.

Установка

Ознакомьтесь с документацией по запуску собственной копии Outline в производственной конфигурации.

Если у вас есть вопросы или улучшения документации, создайте ветку в обсуждениях GitHub.

Разработка

Если вы хотите внести изменения, исправления и улучшения в Outline, существует краткое руководство по настройке среды разработки.

Содействие

Outline создается и поддерживается небольшой командой — мы будем рады вашей помощи в исправлении ошибок и добавлении функций!

Прежде чем отправлять запрос на включение, обсудите это с основной командой, создав или прокомментировав проблему на GitHub — мы также будем рады услышать ваше мнение в обсуждениях. Таким образом, мы можем гарантировать, что подход будет согласован до написания кода. Это приведет к гораздо более высокой вероятности того, что ваш код будет принят.

Если вы ищете способы начать работу, вот список способов помочь нам улучшить Outline:

• Перевод на другие языки
• Проблемы с good first issue
• Улучшения производительности как на сервере, так и во внешнем интерфейсе.
• Счастье разработчиков и документация
• Ошибки и другие проблемы, перечисленные на GitHub.

Архитектура

Если вы хотите внести свой вклад или узнать больше о кодовой базе Outline, сначала обратитесь к документу по архитектуре, чтобы получить общий обзор того, как собирается приложение.

Отладка

В разработке Outline выводит на консоль простые журналы с префиксами по категориям. В рабочей среде он выводит журналы JSON, их можно легко проанализировать с помощью предпочитаемого вами конвейера приема журналов.

Ведение журнала HTTP отключено по умолчанию, но его можно включить, установив переменную среды DEBUG=http .

Тесты

Мы стремимся обеспечить достаточное тестовое покрытие для критических частей приложения и не стремимся к 100%-му покрытию модульными тестами. Все конечные точки API и все, что связано с аутентификацией, должно быть тщательно протестировано.

Чтобы добавить новые тесты, напишите свои тесты с помощью Jest и добавьте файл с расширением .test.js рядом с тестируемым кодом.

 # To run all tests
make test

# To run backend tests in watch mode
make watch

После создания тестовой базы данных с помощью make test вы можете напрямую запускать внешние и внутренние тесты по отдельности.

 # To run backend tests
yarn test:server

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

# To run frontend tests
yarn test:app

Миграции

Sequelize используется для создания и запуска миграций, например:

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

Или запустить миграцию в тестовой базе данных:

yarn sequelize db:migrate --env test

Активность

Лицензия

Outline имеет лицензию BSL 1.1.