Skip to content

Commit 3cc3145

Browse files
SOIVclaude
andcommitted
docs: README / README_ko 개발 현황 및 구성 업데이트
- Phase 1.5 진행률 40% → 90%, 서브 페이즈별 스냅샷 표로 재편 (2026-04-15 기준) - Phase 1.9 완료 항목 추가, Phase 1.95(Setup 설치 마법사) 진행 중 항목 추가 - Quick Start 제거 → Phase 1.95 완료 시 배포 가이드 공개 안내로 대체 - Tech Stack 섹션 추가 (실제 구현 기준) - 로컬 개발 환경 섹션 추가 (pnpm dev:bypass, mock 계정 테이블) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent a46a075 commit 3cc3145

2 files changed

Lines changed: 106 additions & 24 deletions

File tree

README.md

Lines changed: 53 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,45 +29,86 @@ Current phase: **Development in progress (Roadmap Phase 1.5)**
2929

3030
- ✅ Planning and documentation are complete
3131
- ✅ Roadmap Phase 1 (Core foundation) is complete
32-
- 🚧 Development is active, and missing details are being filled during implementation
33-
- 🚧 Roadmap Phase 1.5 (Core Control Plane UI/UX) is in progress
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
3434
- 🎯 Target timeline remains **2026-2027**
3535

3636
### Phase Progress
3737

3838
| Phase | Scope (Roadmap) | Status | Progress |
3939
| ------- | ----------- | ------- | ------- |
4040
| Phase 1 | Core foundation setup | Completed ✅ | 100% |
41-
| Phase 1.5 | Core Control Plane UI/UX | In progress ⏳ | 40% |
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% |
4244
| Phase 2 | Core module development (Ledger, Subscription) | Not started 🚧 | 0% |
4345
| Phase 3 | Marketplace and website | Not started 🚧 | 0% |
4446
| Phase 4 | Deployment optimization | Not started 🚧 | 0% |
4547
| Phase 5 | Expansion and ecosystem | Not started 🚧 | 0% |
4648
| Phase 6 | Community growth (continuous) | Not started 🚧 | 0% |
4749

48-
#### Phase 1.5 Snapshot (2026-02-26)
50+
#### Phase 1.5 Snapshot (2026-04-15)
4951

50-
- Control contracts (P0/P0.5): **100%**
51-
- `@fieldstack/controls` scaffold: **100%**
52-
- Render components (TSX + styles + a11y behaviors): **0%**
53-
- End-to-end flow verification: **0%**
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 ⏳ |
5461

5562
> Note: This phase table follows `docs/v2_FINANCIAL-LEDGER/roadmap/01-development-plan.md` and is updated as implementation progresses.
5663
5764
---
5865

59-
## Quick Start
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.**
84+
> Until then, you can run the project locally in development mode.
85+
86+
### Local Development
6087

61-
### Docker Compose (Recommended)
6288
```bash
6389
git clone https://github.com/fieldstack-project/fieldstack.git
6490
cd fieldstack
91+
pnpm install
92+
93+
# Start PostgreSQL (Docker required)
6594
docker-compose up -d
6695

67-
# Browser will open automatically
68-
→ http://localhost:3000/install
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
69103
```
70104

105+
**Dev mock accounts**
106+
107+
| Role | Email | Password |
108+
| ---- | ----- | -------- |
109+
| Admin | `admin@fieldstack.dev` | `Admin1234!` |
110+
| User | `user@fieldstack.dev` | `User1234!` |
111+
71112
---
72113

73114
## Documentation

README_ko.md

Lines changed: 53 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,45 +29,86 @@ Fieldstack은 개인 생산성과 재무 관리를 위한 오픈소스 기반의
2929

3030
- ✅ 기획 및 문서화 단계 완료
3131
- ✅ 로드맵 Phase 1(Core 기반 구축) 완료
32-
- 🚧 실제 개발을 진행하며 부족한 부분을 병행 보완 중
33-
- 🚧 로드맵 Phase 1.5(Core Control Plane UI/UX) 진행 중
32+
- ✅ 로드맵 Phase 1.9(API 서버 · DB · 인증 백엔드 · 공유 링크) 완료
33+
- 🚧 로드맵 Phase 1.5(Core Control Plane UI/UX) 마무리 단계
3434
- 🎯 전체 목표 타임라인은 **2026-2027** 유지
3535

3636
### Phase 진행 현황
3737

3838
| 단계(Phase) | 범위(로드맵) | 상태 | 진행률 |
3939
| ----------- | ----------- | --- | ----- |
4040
| Phase 1 | Core 기반 구축 | 완료 ✅ | 100% |
41-
| Phase 1.5 | Core Control Plane UI/UX | 진행 중 ⏳ | 40% |
41+
| Phase 1.5 | Core Control Plane UI/UX | 진행 중 ⏳ | 90% |
42+
| Phase 1.9 | API 서버 · DB · 인증 백엔드 · 공유 링크 | 완료 ✅ | 100% |
43+
| Phase 1.95 | Setup 설치 마법사 (모드 전환 · 백엔드 API · UI) | 진행 중 ⏳ | 0% |
4244
| Phase 2 | 기본 모듈 개발(Ledger, Subscription) | 시작 전 🚧 | 0% |
4345
| Phase 3 | 마켓플레이스 및 웹사이트 | 시작 전 🚧 | 0% |
4446
| Phase 4 | 배포 최적화 | 시작 전 🚧 | 0% |
4547
| Phase 5 | 확장 및 생태계 | 시작 전 🚧 | 0% |
4648
| Phase 6 | 커뮤니티 성장(지속) | 시작 전 🚧 | 0% |
4749

48-
#### Phase 1.5 스냅샷 (2026-02-26)
50+
#### Phase 1.5 스냅샷 (2026-04-15)
4951

50-
- Control 계약(P0/P0.5): **100%**
51-
- `@fieldstack/controls` 패키지 기초 스캐폴딩: **100%**
52-
- 실제 렌더 컴포넌트 구현(TSX + 스타일 + 접근성 동작): **0%**
53-
- 설치 -> 로그인 -> 홈 -> 설정/관리자 흐름 통합 검증(E2E): **0%**
52+
| 서브 페이즈 | 범위 | 상태 |
53+
| ----------- | ---- | ---- |
54+
| 1.5.1 | Control UI 컴포넌트 (P0/P0.5 구현 완료, `ready: true`) | 완료 ✅ |
55+
| 1.5.2 | 설치 마법사 개발용 bypass (`dev:bypass`) | 완료 ✅ |
56+
| 1.5.3 | 로그인 UX (실패/잠금/세션 만료, 비밀번호 복구, mock 계정 시스템) | 완료 ✅ |
57+
| 1.5.4 | 메인 홈 (사이드바, 딥 링크, 모바일 Drawer, 온보딩 배너) | 완료 ✅ |
58+
| 1.5.5 | 관리자 대시보드 / 일반 설정 (PIN step-up, 감사 로그, dirty-state 저장) | 완료 ✅ |
59+
| 1.5.6 | UX 품질 기준 (반응형 브레이크포인트, QA 체크리스트, 접근성, 톤 가이드) | 완료 ✅ |
60+
| 게이트 | 접근성/반응형/E2E 통과 · UI 계약 동결 | 진행 중 ⏳ |
5461

5562
> 참고: 본 Phase 표는 `docs/v2_FINANCIAL-LEDGER/roadmap/01-development-plan.md` 기준이며, 구현 진행에 따라 갱신됩니다.
5663
5764
---
5865

59-
## 빠른 시작
66+
## 기술 스택
67+
68+
| 레이어 | 기술 |
69+
| ------ | ---- |
70+
| 프론트엔드 | React 19, Vite, TypeScript (strict) |
71+
| 백엔드 | Node.js, Express 5, tsx |
72+
| 데이터베이스 | PostgreSQL (1순위) · SQLite (예정) |
73+
| 인증 | JWT, TOTP 2FA, Argon2id |
74+
| 모노레포 | pnpm workspaces |
75+
| 테스트 | Vitest |
76+
| UI 컴포넌트 | `@fieldstack/controls` (내부 패키지), Storybook |
77+
| 스타일링 | CSS 커스텀 프로퍼티 (디자인 토큰 시스템) |
78+
79+
---
80+
81+
## 시작하기
82+
83+
> **프로덕션 배포 가이드는 Setup 설치 마법사(Phase 1.95) 완료 시점에 공개됩니다.**
84+
> 그 전까지는 아래 방법으로 로컬 개발 환경에서 실행할 수 있습니다.
85+
86+
### 로컬 개발 환경
6087

61-
### Docker Compose (권장)
6288
```bash
6389
git clone https://github.com/fieldstack-project/fieldstack.git
6490
cd fieldstack
91+
pnpm install
92+
93+
# PostgreSQL 실행 (Docker 필요)
6594
docker-compose up -d
6695

67-
# 브라우저가 자동으로 열립니다
68-
→ http://localhost:3000/install
96+
# 개발 서버 실행 (web + api 병렬)
97+
pnpm dev:bypass # 설치 마법사 스킵
98+
# → Web: http://localhost:5173
99+
# → API: http://localhost:3000
100+
101+
# Storybook (UI 컴포넌트 확인)
102+
pnpm storybook # http://localhost:6007
69103
```
70104

105+
**개발용 mock 계정**
106+
107+
| 역할 | 이메일 | 비밀번호 |
108+
| ---- | ------ | -------- |
109+
| 관리자 | `admin@fieldstack.dev` | `Admin1234!` |
110+
| 일반 사용자 | `user@fieldstack.dev` | `User1234!` |
111+
71112
---
72113

73114
## 문서

0 commit comments

Comments
 (0)