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."。本文只整理仓库能直接核验的内容,不把星标、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 如果仓库没有提供命令,本文不会替它编造安装步骤,而是建议先打开 README 的"🧭 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)。