嘿

嘿莫諾雷波

要求

• Node.js（v18 或更高版本）- 我們專案的主幹，請確保您已安裝它。
• pnpm - 我們值得信賴的套件管理器，因為誰不喜歡更快的安裝？
• Postgres 應用程式 - 我們選擇的資料庫，因為資料需要一個舒適的家。
• Redis - 快速的內存資料存儲，適合您需要快速完成工作的情況。

安裝

我們利用 pnpm 工作區的力量來保持我們的 monorepo 比新鮮黃油煎餅運行得更順暢。

克隆儲存庫

將 Hey monorepo 克隆到本機：

git clone [email protected]:/repos/hey/hey.git

安裝 NVM（節點版本管理器）和 pnpm

搖擺 macOS？您可以像真正的釀酒大師一樣使用 Homebrew 獲取兩者：

brew install nvm pnpm

安裝 Node.js

使用nvm召喚你需要的 Node.js 神奇版本：

nvm install

安裝依賴項

將自己傳送到儲存庫的根目錄並讓 pnpm 施展其依賴魔法：

pnpm install

建立.env文件

引導您的內部嚮導，並從.env.example範本為每個需要它的套件和應用程式建立一個.env檔案。不要忘記添加必要的環境變數！

cp .env.example .env

不要忘記模仿並為每個需要它的套件和應用程式重複建立.env檔案。一致性是關鍵！

啟動應用程式

當所有的星星對齊並且一切就位時，在開發模式下啟動應用程式：

pnpm dev

建置和測試

建立應用程式

準備好建立應用程式了嗎？只需運行這個命令：

pnpm build

測試應用程式

想在開發時執行測試嗎？操作方法如下：

pnpm test 

週期性任務

刪除未使用的匯出和助手

我們使用ts-prune來尋找並消除潛伏在程式碼庫中未使用的匯出和幫助程式。請注意：您需要為每個套件和應用程式手動執行此任務。快樂修剪！

 cd apps/web ; npx ts-prune -i generated.ts

更新依賴項

是時候對我們的依賴項進行改造了！我們依靠pnpm的神奇力量來保持一切最新且清晰。

script/clean-branches
script/update-dependencies

更新鎖定文件

我們相信pnpm能讓我們的鎖定檔案保持新鮮和精彩！

script/clean-branches
script/update-lock-file

您可能喜歡的其他工具

瑞普格雷普

我們使用 Ripgrep 在程式碼庫中搜尋文字。這就像grep和ag生了一個孩子，而那個孩子長大後成為了速度惡魔！

透過 Homebrew 安裝它：

brew install ripgrep

在程式碼庫中搜尋文字：

rg " const Verified "

捆綁分析儀

在apps/web中，我們有一個套件分析器，可以洩漏我們生產包的大小和內容。這就像對您的程式碼進行 X 射線透視一樣！

若要產生此輸出，請執行：

 cd apps/web
ANALYZE=true pnpm build

啟動此命令來建立apps/web項目，並觀察三個瀏覽器視窗神奇地彈出，每個視窗都顯示節點、邊緣和客戶端捆綁包的捆綁包詳細資訊。客戶端捆綁包是頁面效能的超級英雄，而所有捆綁包在開發和建置效能中都發揮著至關重要的作用。

行為守則

我們懇請所有貢獻者和團隊成員遵守我們的行為準則。將其視為我們社區的黃金規則手冊 - 玩得開心並保持良好的氛圍！

執照

該專案是在AGPL-3.0許可證下開源的。有關所有詳細信息，請查看許可證文件。這真是一本引人入勝的書！

聚苯乙烯

我們 ？你去月球並返回！您的支援就像我們的程式碼源源不絕的咖啡。感謝您讓 Hey 成為宇宙中最棒的地方！

？