You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
sims-hq/README.md

50 lines
3.8 KiB
Markdown

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# SiMS Next — Store Management Suite (Rebuild)
A ground-up rebuild of SiMS Store Software: GST-compliant retail management for India —
inventory, POS billing, purchases, and accounting — for everything from a single-counter
kirana shop to multi-outlet supermarket chains.
**Why the rebuild:** the current product runs on Oracle Forms & Reports (hard to maintain,
buggy, no path to cloud/multi-store), and the market is moving. Same customers, much better
product.
**North star:** the fastest, easiest counter workflow in the market. The customer in line
never waits because of the software, and purchase entry is never a burden.
## Build state (start here)
This is now a working codebase, not just a plan. Current state, run instructions, and the
live-vs-wireframe breakdown live in **[STATUS.md](STATUS.md)** and **[BUILDING.md](BUILDING.md)**.
In brief: a web-app POS + back office served by a Node store-server over a portable data
layer (SQLite dev slice; Oracle 12c adapter pending the Classic DDL). Live and verified
end-to-end: billing (keyboard-first, offline-capable, B2B/IGST), purchases with batch/
expiry, returns/credit notes, and GST returns (GSTR-1/3B). A full adversarial security
review + P0P2 remediation is complete — see [docs/18-RED-TEAM-REVIEW.md](docs/18-RED-TEAM-REVIEW.md).
## Planning documents
| Doc | What it covers |
|-----|----------------|
| [docs/00-VISION.md](docs/00-VISION.md) | Product vision, segments/editions, business model, success metrics |
| [docs/01-SCOPE.md](docs/01-SCOPE.md) | Full module & feature catalog with priorities and edition mapping |
| [docs/02-ARCHITECTURE.md](docs/02-ARCHITECTURE.md) | Offline vs online vs hybrid analysis, sync design, tech stack, multi-tenancy |
| [docs/03-FRONTEND.md](docs/03-FRONTEND.md) | App surfaces, counter UX principles, screen inventory, design system |
| [docs/04-ROADMAP.md](docs/04-ROADMAP.md) | Phased build plan with exit criteria, pilot & migration strategy |
| [docs/05-CHECKLIST.md](docs/05-CHECKLIST.md) | Master build checklist, grouped by area |
| [docs/06-DECISIONS.md](docs/06-DECISIONS.md) | Open decisions that need a founder call, with recommendations |
| [docs/07-DB-AND-CONFIG.md](docs/07-DB-AND-CONFIG.md) | Everything-in-DB design (messages, plans, settings), local DB engine analysis (D12) |
| [docs/08-MARKET-ARCHITECTURES.md](docs/08-MARKET-ARCHITECTURES.md) | How Tally/Marg/GoFrugal/Vyapar & global players architect; Android POS conclusion |
| [docs/09-UX-FLOWS-AND-MENUS.md](docs/09-UX-FLOWS-AND-MENUS.md) | Screen-level UX blueprint: POS flows, back-office menu tree, Purchase Inbox, owner app |
| [docs/10-ISSUES-REGISTER.md](docs/10-ISSUES-REGISTER.md) | Consolidated failure-mode register across 6 lenses, with Top-10 risk ranking |
| [docs/11-ADMIN-SUPPORT-CONSOLE.md](docs/11-ADMIN-SUPPORT-CONSOLE.md) | Settings hierarchy, tenant Admin review, and the vendor-side HQ/support console |
| docs/13-SPEC-*.md | Keystroke-level specs: billing polish + purchase entry (P1/P2 backlog) |
| [docs/14-SPEC-HQ-CONSOLE.md](docs/14-SPEC-HQ-CONSOLE.md) | HQ ops console for the Classic client base (D15, apps/hq) |
| [docs/15-EDITIONS.md](docs/15-EDITIONS.md) | Lite/Standard/Pro/Enterprise: privileges, limits, costs — all configurable DB rows |
| [docs/16-PROJECT-RULES.md](docs/16-PROJECT-RULES.md) | The 26 hard rules (Tables Rule, money rules, config-over-code, counter rules) |
| [docs/17-SCALE-AND-INTEGRATIONS.md](docs/17-SCALE-AND-INTEGRATIONS.md) | The 7 committed scale gaps + full integrations catalog with status |
| [docs/18-RED-TEAM-REVIEW.md](docs/18-RED-TEAM-REVIEW.md) | Adversarial security review + remediation record (all findings closed) |
| [DEPLOY-HQ.md](DEPLOY-HQ.md) | Go-live runbook for the HQ ops console (apps/hq) |
Start with STATUS.md for what's built; then 00-VISION, 02-ARCHITECTURE, 04-ROADMAP for the plan.