marcoturi/fastify-boilerplate:README 來源編輯指南
根據 README、倉庫資料與授權整理 marcoturi/fastify-boilerplate 的安裝與核驗路徑。
專案定位
marcoturi/fastify-boilerplate 的 README 將專案描述為「Fastify 5 application boilerplate based on clean architecture, domain-driven design, CQRS, functional programming, vertical slice architecture for building production-grade applications 🚀」。本文只整理倉庫可直接核對的內容,不把 star、Fork 或宣傳語當成品質證明。README 在「README」下寫到:A production-ready Fastify 5 boilerplate built on Clean Architecture, CQRS, DDD, and functional programming. Designed as a starting point for real-world applications, the architecture is framework-agnostic at its core , the patterns and。這說明的是專案邊界,不是已完成的生產驗證。
適用場景
從 README 的「Dockerfile highlights」與相關條目,可以先判斷它是否處理你的實際問題:Node Alpine , small footprint, native TypeScript execution (no build step)。若需求不同,不應只因專案熱度就採用。本文保留原始專案名、命令與元件名,方便回到一手來源核對。 README 另外列出一項可核對的資訊:Multi-stage build , dependencies installed in an isolated stage for optimal layer caching。這類原文條目可用來設計試跑步驟,但不能取代實際環境測試。
運作方式
README 將運作方式分散在「Prerequisites」等段落。可確認的線索包括:| Tool | Notes | |---|---| | Node.js | >= 24 , required for native TypeScript execution. A .nvmrc is included , run fnm use or nvm use | | pnpm | >= 10 , package manager (corepack enable to activate) | | Docker | Used to run PostgreSQL via。本文不把未寫出的架構、效能或安全邊界補成結論;真正的執行鏈仍要配合目錄、設定檔與版本標籤檢查。
安裝與第一次執行
第一次安裝應從 README 指出的入口開始。目前可核對的命令是: # 1. Scaffold from the template npx degit marcoturi/fastify-boilerplate my-app cd my-app # 2. Install dependencies pnpm install # 3. Create your .env file pnpm create:env # copies .env.example → .env # 4. Start PostgreSQL (pick one) docker compose up postgres -d # via Docker Compose # , or use a local Postgres and adjust .env values , # 5. Run database migrations pnpm db:migrate # 6. Start the dev server (with watch mode and pretty logs) pnpm start 如果倉庫沒有命令,本文不會自行編造步驟,而是建議先閱讀「Features」,確認系統依賴、預設埠與首次初始化。
設定與日常使用
日常使用取決於專案文件。README 的「Development」段落提到:| Script | Description | |---|---| | pnpm start | Start dev server with watch mode and pretty-printed logs | | pnpm start:prod | Start production server (no watch, no pretty-print) | | pnpm create:env | Copy .env.example to .env (fails if .。設定檔、環境變數、權限與資料目錄只在來源明確時才會記錄;沒有寫出的預設值,應在測試環境驗證並保留回滾副本。 同一部分也提到:Non-root user , runs as an unprivileged fastify user (UID 1001)。