outline

React と Node.js を使用して構築された、チーム向けの高速で共同作業が可能なナレッジ ベースです。
www.getoutline.com でホストされているバージョンを使用して、Outline を試してみてください。

これは、 Outlineとすべての関連サービスを実行するソース コードです。アウトラインを使用する場合は、このコードを実行する必要はありません。アプリのホストされたバージョンが getoutline.com で提供されています。ガイドには、Outline の使用に関するドキュメントもあります。

Outline の独自のコピーを実行したい場合、または開発に貢献したい場合は、ここが最適な場所です。

インストール

実稼働環境でのアウトラインの独自のコピーの実行については、ドキュメントを参照してください。

ドキュメントに関する質問や改善点がある場合は、GitHub ディスカッションにスレッドを作成してください。

発達

変更、修正、Outline の改善に貢献したい場合は、開発環境をセットアップするための短いガイドがあります。

貢献する

アウトラインは少人数のチームによって構築および保守されています。バグの修正や機能の追加にご協力をお待ちしています。

プル リクエストを送信する前に、GitHub で問題を作成するかコメントして、コア チームと話し合ってください。ディスカッションでのご意見もお待ちしています。こうすることで、コードを作成する前にアプローチが合意されていることを確認できます。これにより、コードが受け入れられる可能性が大幅に高くなります。

始める方法をお探しの場合は、Outline の改善に役立つ方法のリストを以下に示します。

• 他の言語への翻訳
• good first issue号
• サーバーとフロントエンドの両方でパフォーマンスが向上しました
• 開発者の満足度とドキュメント化
• GitHub にリストされているバグとその他の問題

建築

貢献することに興味がある場合、またはアウトライン コードベースについて詳しく知りたい場合は、まずアーキテクチャ ドキュメントを参照して、アプリケーションがどのように組み立てられているかの概要を確認してください。

デバッグ

開発中の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

活動

ライセンス

アウトラインはBSL 1.1ライセンスを取得しています。