ulsklyc/yuvomi:README 来源编辑指南
基于 README、仓库元数据和许可证整理 ulsklyc/yuvomi 的安装与核验路径。
项目定位
ulsklyc/yuvomi 的 README 将项目描述为"Self-hosted family planner - tasks, calendars, shopping, meals, budget. Your data, your server."。本文只整理仓库能直接核验的内容,不把星标、Fork 或宣传语当成质量证明。README 在"README"下的说明是:Tasks, calendar, budget, groceries, meals, health and more, self-hosted on your own server. No cloud accounts. No subscriptions. Zero trackers. Your family's data stays yours.。这给出的首先是项目边界,而不是已经完成的生产验证。
适用场景
从 README 的"Modules"和相关条目看,读者可以先判断它是否解决自己的具体问题:Shopping - Collaborative lists grouped by aisle, with swipe gestures, per-item notes, one-tap import from the meal plan, and a handover of everything you ticked off straight into the Pantry.。如果你的目标与这段说明不一致,就不应仅凭项目热度采用它。这里保留原项目名、命令和组件名,方便回到一手来源核对。 README 还列出了另一条可核对的信息:Tasks - Deadlines, priorities, subtasks, recurring schedules, multi-member assignment, per-task visibility (only me / assignees / everyone), customizable categories, free-form tags, linked documents from the Documents module, an "assigned。这类原文条目可以帮助读者设计试运行步骤,但不能代替自己的环境测试。
工作方式
README 把工作方式分散写在"Why Yuvomi"等段落中。可确认的线索包括:Most families glue their life together from a dozen paid apps, each with its own account, its own subscription, and its own copy of your data on someone else's server. Yuvomi brings that into one place you own.。这篇整理没有把未写出的架构、性能或安全边界补成结论;真正的运行链仍应结合仓库目录、配置文件和版本标签检查。
安装与第一次运行
第一次安装应从 README 给出的入口开始。当前可复核的命令是: git clone https://github.com/ulsklyc/yuvomi.git && cd yuvomi node tools/installer/install-server.js 如果仓库没有提供命令,本文不会替它编造安装步骤,而是建议先打开 README 的"One private app instead of a dozen subscriptions"部分,确认系统依赖、默认端口和首次初始化动作。
配置与日常使用
日常使用的细节取决于项目实际文档。README 的"One private app instead of a dozen subscriptions"段落提到:| Instead of juggling… | Yuvomi gives you | |---|---| | a to-do & task app | Tasks - Kanban, deadlines, recurring, multi-assignment | | a shared calendar subscription | Calendar - sync, subscriptions, per-event visibility | | a。对于配置文件、环境变量、权限和数据目录,当前稿只记录来源明确的部分;未写明的默认值必须在测试环境中验证,并保留可回滚的配置副本。 同一部分还提到:Meals - Weekly planner with multiple items per slot, weekly repeats, a drag-and-drop recipe sidebar, a one-click week randomizer, and direct export to the shopping list.。