|
1 | | -# Fieldstack |
2 | | - |
3 | | -> Personal modular productivity framework |
4 | | -
|
5 | | -[](README_ko.md) |
6 | | -[](https://opensource.org/licenses/MIT) |
7 | | -[](https://github.com/fieldstack-project) |
8 | | - |
9 | | ---- |
10 | | - |
11 | | -## About |
12 | | - |
13 | | -Fieldstack is an open-source, self-hosted modular framework for personal productivity and finance management. |
14 | | - |
15 | | -**Developed and maintained by** [PSquare DIVISION](https://github.com/psquare-division) |
16 | | - |
17 | | -### Core Values |
18 | | -- ✅ **Completely Free** - No feature restrictions |
19 | | -- ✅ **Self-hosted** - Your data, your control |
20 | | -- ✅ **Modular** - Install only what you need |
21 | | -- ✅ **Open Source** - MIT License |
22 | | -- ✅ **Community-driven** - Built together |
23 | | - |
24 | | ---- |
25 | | - |
26 | | -## Development Status |
27 | | - |
28 | | -Current phase: **Development in progress (Roadmap Phase 1.5)** |
29 | | - |
30 | | -- ✅ Planning and documentation are complete |
31 | | -- ✅ Roadmap Phase 1 (Core foundation) is complete |
32 | | -- ✅ Roadmap Phase 1.9 (API server, DB, auth backend, shared links) is complete |
33 | | -- 🚧 Roadmap Phase 1.5 (Core Control Plane UI/UX) is nearing completion |
34 | | -- 🎯 Target timeline remains **2026-2027** |
35 | | - |
36 | | -### Phase Progress |
37 | | - |
38 | | -| Phase | Scope (Roadmap) | Status | Progress | |
39 | | -| ------- | ----------- | ------- | ------- | |
40 | | -| Phase 1 | Core foundation setup | Completed ✅ | 100% | |
41 | | -| Phase 1.5 | Core Control Plane UI/UX | In progress ⏳ | 90% | |
42 | | -| Phase 1.9 | API server · DB · auth backend · shared links | Completed ✅ | 100% | |
43 | | -| Phase 1.95 | Setup install wizard (mode switch · backend API · UI) | In progress ⏳ | 0% | |
44 | | -| Phase 2 | Core module development (Ledger, Subscription) | Not started 🚧 | 0% | |
45 | | -| Phase 3 | Marketplace and website | Not started 🚧 | 0% | |
46 | | -| Phase 4 | Deployment optimization | Not started 🚧 | 0% | |
47 | | -| Phase 5 | Expansion and ecosystem | Not started 🚧 | 0% | |
48 | | -| Phase 6 | Community growth (continuous) | Not started 🚧 | 0% | |
49 | | - |
50 | | -#### Phase 1.5 Snapshot (2026-04-15) |
51 | | - |
52 | | -| Sub-phase | Scope | Status | |
53 | | -| --------- | ----- | ------ | |
54 | | -| 1.5.1 | Control UI components (P0/P0.5 implemented, `ready: true`) | Done ✅ | |
55 | | -| 1.5.2 | Install wizard dev bypass (`dev:bypass`) | Done ✅ | |
56 | | -| 1.5.3 | Login UX (failure/lock/session expiry, password recovery, mock accounts) | Done ✅ | |
57 | | -| 1.5.4 | Main Home (sidebar, deep link routing, mobile drawer, onboarding banner) | Done ✅ | |
58 | | -| 1.5.5 | Admin dashboard / general settings (PIN step-up, audit log, dirty-state save) | Done ✅ | |
59 | | -| 1.5.6 | UX quality baseline (responsive breakpoints, QA checklist, a11y, tone guide) | Done ✅ | |
60 | | -| Gate | Accessibility / responsive / E2E pass · UI contract freeze | Pending ⏳ | |
61 | | - |
62 | | -> Note: This phase table follows `docs/v2_FINANCIAL-LEDGER/roadmap/01-development-plan.md` and is updated as implementation progresses. |
63 | | -
|
64 | | ---- |
65 | | - |
66 | | -## Tech Stack |
67 | | - |
68 | | -| Layer | Technology | |
69 | | -| ----- | ---------- | |
70 | | -| Frontend | React 19, Vite, TypeScript (strict) | |
71 | | -| Backend | Node.js, Express 5, tsx | |
72 | | -| Database | PostgreSQL (primary) · SQLite (planned) | |
73 | | -| Auth | JWT, TOTP 2FA, Argon2id | |
74 | | -| Monorepo | pnpm workspaces | |
75 | | -| Testing | Vitest | |
76 | | -| UI Components | `@fieldstack/controls` (internal), Storybook | |
77 | | -| Styling | CSS custom properties (design token system) | |
78 | | - |
79 | | ---- |
80 | | - |
81 | | -## Getting Started |
82 | | - |
83 | | -> **Production deployment guide will be published when the Setup install wizard (Phase 1.95) is complete.**<br> |
84 | | -> Until then, you can run the project locally in development mode. |
85 | | -
|
86 | | -### Local Development |
87 | | - |
88 | | -```bash |
89 | | -git clone https://github.com/fieldstack-project/fieldstack.git |
90 | | -cd fieldstack |
91 | | -pnpm install |
92 | | - |
93 | | -# Start PostgreSQL (Docker required) |
94 | | -docker-compose up -d |
95 | | - |
96 | | -# Run dev server (web + api in parallel) |
97 | | -pnpm dev:bypass # skip install wizard |
98 | | -# → Web: http://localhost:5173 |
99 | | -# → API: http://localhost:3000 |
100 | | - |
101 | | -# Storybook (UI components) |
102 | | -pnpm storybook # http://localhost:6007 |
103 | | -``` |
104 | | - |
105 | | -**Dev mock accounts** |
106 | | - |
107 | | -| Role | Email | Password | |
108 | | -| ---- | ----- | -------- | |
109 | | -| Admin | `admin@fieldstack.dev` | `Admin1234!` | |
110 | | -| User | `user@fieldstack.dev` | `User1234!` | |
111 | | - |
112 | | ---- |
113 | | - |
114 | | -## Documentation |
115 | | - |
116 | | -📚 [Official Documentation](https://docs.fieldstack.dev)<br> |
117 | | -🏪 [Marketplace](https://marketplace.fieldstack.dev)<br> |
118 | | -💬 [Community Discord](https://discord.gg/5m4aHKmWgg) |
119 | | - |
120 | | ---- |
121 | | - |
122 | | -## License |
123 | | - |
124 | | -MIT License - see [LICENSE](LICENSE) for details |
125 | | - |
126 | | -**Copyright © 2026 Fieldstack Project Contributors**<br> |
127 | | -**Developed and maintained by PSquare DIVISION** |
| 1 | +# Fieldstack |
| 2 | + |
| 3 | +> Personal modular productivity framework |
| 4 | +
|
| 5 | +[](README_ko.md) |
| 6 | +[](https://opensource.org/licenses/MIT) |
| 7 | +[](https://github.com/fieldstack-project) |
| 8 | + |
| 9 | +--- |
| 10 | + |
| 11 | +## About |
| 12 | + |
| 13 | +Fieldstack is an open-source, self-hosted modular framework for personal productivity and finance management. |
| 14 | + |
| 15 | +**Developed and maintained by** [PSquare DIVISION](https://github.com/psquare-division) |
| 16 | + |
| 17 | +### Core Values |
| 18 | +- ✅ **Completely Free** - No feature restrictions |
| 19 | +- ✅ **Self-hosted** - Your data, your control |
| 20 | +- ✅ **Modular** - Install only what you need |
| 21 | +- ✅ **Open Source** - MIT License |
| 22 | +- ✅ **Community-driven** - Built together |
| 23 | + |
| 24 | +--- |
| 25 | + |
| 26 | +## Development Status |
| 27 | + |
| 28 | +Current phase: **Phase 2.2 — Subscription module in progress** |
| 29 | + |
| 30 | +- Phase 1 · 1.5 · 1.9 · 1.95 — all complete |
| 31 | +- Phase 2 pre-work (ModuleRegistry, module management API, per-user activation) — complete |
| 32 | +- Phase 2.1 Ledger (backend + frontend, CSV import/export, budgets, receipt attachments) — complete |
| 33 | +- Phase 2.x core infrastructure (i18n, Event Bus, Core Scheduler, exchange rates) — mostly complete |
| 34 | +- Phase 2.2 Subscription — core features complete, remaining: Google Calendar, calendar view, timezone strategy |
| 35 | +- Target timeline: **2026–2027** |
| 36 | + |
| 37 | +### Phase Progress |
| 38 | + |
| 39 | +| Phase | Scope | Status | Progress | |
| 40 | +| ----- | ----- | ------ | -------- | |
| 41 | +| Phase 1 | Core foundation setup | Completed ✅ | 100% | |
| 42 | +| Phase 1.5 | Core Control Plane UI/UX | Completed ✅ | 100% | |
| 43 | +| Phase 1.9 | API server · DB · auth backend · shared links | Completed ✅ | 100% | |
| 44 | +| Phase 1.95 | Setup install wizard (mode switch · backend API · UI · reset) | Completed ✅ | 100% | |
| 45 | +| Phase 2 Pre | ModuleRegistry · module management API · per-user activation | Completed ✅ | 100% | |
| 46 | +| Phase 2.1 | Ledger module (backend + frontend) | Completed ✅ | 100% | |
| 47 | +| Phase 2.x | Core systems (i18n · Event Bus · Scheduler · exchange rates) | Mostly complete ⏳ | ~80% | |
| 48 | +| Phase 2.2 | Subscription module | In progress ⏳ | ~70% | |
| 49 | +| Phase 3 | Marketplace and website | Not started 🚧 | 0% | |
| 50 | +| Phase 4 | Deployment optimization | Not started 🚧 | 0% | |
| 51 | +| Phase 5 | Expansion and ecosystem | Not started 🚧 | 0% | |
| 52 | +| Phase 6 | Community growth (continuous) | Not started 🚧 | 0% | |
| 53 | + |
| 54 | +#### Phase 2.2 Subscription — Remaining |
| 55 | + |
| 56 | +| Item | Status | |
| 57 | +| ---- | ------ | |
| 58 | +| Core features (CRUD · price history · stats · notes · scheduler · Event Bus) | Done ✅ | |
| 59 | +| Cumulative stats with status history (pause/resume periods excluded) | Done ✅ | |
| 60 | +| Payment calendar view | Pending ⏳ | |
| 61 | +| Ledger auto-sync (`subscription:payment` event receiver) | Pending ⏳ | |
| 62 | +| Timezone strategy (display vs. billing calculation separation) | Pending ⏳ | |
| 63 | +| Google Calendar integration | Pending ⏳ | |
| 64 | + |
| 65 | +> Note: This table follows `docs/v2_FINANCIAL-LEDGER/roadmap/01-development-plan.md` and is updated as implementation progresses. |
| 66 | +
|
| 67 | +--- |
| 68 | + |
| 69 | +## Tech Stack |
| 70 | + |
| 71 | +| Layer | Technology | |
| 72 | +| ----- | ---------- | |
| 73 | +| Frontend | React 19, Vite, TypeScript (strict) | |
| 74 | +| Backend | Node.js, Express 5, tsx | |
| 75 | +| Database | PostgreSQL (primary) · SQLite via `better-sqlite3` | |
| 76 | +| Auth | JWT, TOTP 2FA, Argon2id | |
| 77 | +| i18n | i18next · react-i18next (ko / en) | |
| 78 | +| Scheduler | node-cron (Core Scheduler with DB logging) | |
| 79 | +| Exchange rates | Frankfurter API (DB-cached) | |
| 80 | +| Monorepo | pnpm workspaces | |
| 81 | +| Testing | Vitest | |
| 82 | +| UI Components | `@fieldstack/controls` (internal), Storybook | |
| 83 | +| Styling | CSS custom properties (design token system) | |
| 84 | +| Tunneling | Cloudflare Tunnel (Quick / Named) | |
| 85 | + |
| 86 | +--- |
| 87 | + |
| 88 | +## Getting Started |
| 89 | + |
| 90 | +> **Production deployment guide will be published when Phase 2 is complete.**<br> |
| 91 | +> Until then, you can run the project locally in development mode. |
| 92 | +
|
| 93 | +### Local Development |
| 94 | + |
| 95 | +```bash |
| 96 | +git clone https://github.com/fieldstack-project/fieldstack.git |
| 97 | +cd fieldstack |
| 98 | +pnpm install |
| 99 | + |
| 100 | +# Start PostgreSQL (Docker required) |
| 101 | +docker-compose up -d |
| 102 | + |
| 103 | +# Run dev server (web + api in parallel) |
| 104 | +pnpm dev:bypass # skip install wizard |
| 105 | +# → Web: http://localhost:5173 |
| 106 | +# → API: http://localhost:3000 |
| 107 | + |
| 108 | +# Storybook (UI components) |
| 109 | +pnpm storybook # http://localhost:6007 |
| 110 | +``` |
| 111 | + |
| 112 | +**Dev mock accounts** |
| 113 | + |
| 114 | +| Role | Email | Password | |
| 115 | +| ---- | ----- | -------- | |
| 116 | +| Admin | `admin@fieldstack.dev` | `Admin1234!` | |
| 117 | +| User | `user@fieldstack.dev` | `User1234!` | |
| 118 | + |
| 119 | +--- |
| 120 | + |
| 121 | +## Documentation |
| 122 | + |
| 123 | +📚 [Official Documentation](https://docs.fieldstack.dev)<br> |
| 124 | +🏪 [Marketplace](https://marketplace.fieldstack.dev)<br> |
| 125 | +💬 [Community Discord](https://discord.gg/5m4aHKmWgg) |
| 126 | + |
| 127 | +--- |
| 128 | + |
| 129 | +## License |
| 130 | + |
| 131 | +MIT License - see [LICENSE](LICENSE) for details |
| 132 | + |
| 133 | +**Copyright © 2026 Fieldstack Project Contributors**<br> |
| 134 | +**Developed and maintained by PSquare DIVISION** |
0 commit comments