liketrek/TREK:README 來源編輯指南
根據 README、倉庫資料與授權整理 liketrek/TREK 的安裝與核驗路徑。
專案定位
liketrek/TREK 的 README 將專案描述為「A self-hosted travel/trip planner with real-time collaboration, interactive maps, PWA support, SSO, budgets, packing lists, and more.」。本文只整理倉庫可直接核對的內容,不把 star、Fork 或宣傳語當成品質證明。README 在「README」下寫到:A self-hosted, real-time collaborative travel planner , with maps, budgets, packing lists, a journal, and AI built in.。這說明的是專案邊界,不是已完成的生產驗證。
適用場景
從 README 的「🧭 Trip planning」與相關條目,可以先判斷它是否處理你的實際問題:Interactive map , Leaflet or Mapbox GL with 3D buildings, terrain, photo markers, clustering, route visualization。若需求不同,不應只因專案熱度就採用。本文保留原始專案名、命令與元件名,方便回到一手來源核對。 README 另外列出一項可核對的資訊:Drag & drop planner , organise places into day plans with reordering and cross-day moves。這類原文條目可用來設計試跑步驟,但不能取代實際環境測試。
運作方式
README 將運作方式分散在「Get started in 30 seconds」等段落。可確認的線索包括: · Docker Compose · Helm / Kubernetes · Install as PWA · Reverse Proxy · 。本文不把未寫出的架構、效能或安全邊界補成結論;真正的執行鏈仍要配合目錄、設定檔與版本標籤檢查。
安裝與第一次執行
第一次安裝應從 README 指出的入口開始。目前可核對的命令是: ENCRYPTION_KEY=$(openssl rand -hex 32) docker run -d -p 3000:3000 \ -e ENCRYPTION_KEY=$ENCRYPTION_KEY \ -v ./data:/app/data -v ./uploads:/app/uploads mauriceboe/trek 如果倉庫沒有命令,本文不會自行編造步驟,而是建議先閱讀「🧭 Trip planning」,確認系統依賴、預設埠與首次初始化。
設定與日常使用
日常使用取決於專案文件。README 的「Tech stack」段落提到:Real-time sync via WebSocket (ws). Backend on NestJS 11. State with Zustand. Auth via JWT + OAuth 2.1 + OIDC + Passkeys (WebAuthn) + TOTP MFA. Weather via Open-Meteo (no key required). Maps with Leaflet and Mapbox GL.。設定檔、環境變數、權限與資料目錄只在來源明確時才會記錄;沒有寫出的預設值,應在測試環境驗證並保留回滾副本。 同一部分也提到:Place search , Google Places (photos, ratings, hours) or OpenStreetMap (free, no API key)。