outline

使用 React 和 Node.js 為您的團隊建立快速、協作的知識庫。
使用我們位於 www.getoutline.com 的託管版本試用 Outline。

這是運行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 許可。