POS / Contribute
Contribute
Code, docs, case studies, translations — even a reproducible bug report counts.
Get it running first
You need Go 1.22+, Node 20+ and Git. Backend and frontend build separately; the frontend output is embedded into a single Go binary.
git clone https://gitee.com/yixin-lot/posd.git && cd posd npm --prefix web ci npm --prefix web run build node scripts/copy-embed.mjs # 前端产物拷进后端 embed 目录 go run ./cmd/posd # 默认 http://127.0.0.1:8080
First launch creates the database and seeds sample products; the admin password is generated on the first login screen, never hard-coded.
Ways to help
Report bugs
Include version, OS, reproduction steps and logs. Reproducible bugs get priority.
Send code
One PR does one thing, with the motivation and blast radius spelled out. Schema changes must include migration and rollback notes.
Write docs
User manual, deployment notes, troubleshooting. Screenshots must come from a real run — no mock-ups.
Share a case
How a real shop uses it, with numbers where possible (anonymised). Cases go on the site and persuade more effectively than feature lists.
Translate
English copy, currency and date formats, local payment habits. Chinese and English come first; other languages are open for adoption.
Request features
Describe the situation and the workaround you use today in Discussions. Upvoted requests get scheduled.
PR rules
Branch from main and name it `feat/…`, `fix/…` or `docs/…`.
Before pushing, run the frontend tests, the build, and `node scripts/e2e/mobile375.mjs` — it actually fails on overflow at 375 px.
Say what changed, why, and how you verified it. Paste real command output; “tested” is not evidence.
First-time contributors sign a CLA confirming they have the right to contribute this code.
The CLA only grants the project the right to use your contribution; you keep the copyright.
Roadmap
Shipped in capability batches, not date promises. See the repository releases for the latest version.
v1.0 · install and sell
A Windows installer first, macOS and Linux to follow; first-run setup, backup and migration, and the full loop from register to reports.
v1.1 · mobile and tables
Mobile register, table merge and transfer, kitchen routing made usable on narrow screens.
v1.2 · going global
Multi-currency and tax configuration, complete English UI, local receipt templates.
v2.0 · extension points
Plugin interfaces and event hooks for printing and payments, so third parties can integrate without touching the core.