Refactor app structure and simplify team docs
This commit is contained in:
59
README.md
Normal file
59
README.md
Normal file
@@ -0,0 +1,59 @@
|
||||
# MH Dashboard Organization
|
||||
|
||||
조직현황, 자리배치도, 프로젝트별 분석, 팀/개인별 분석을 하나의 대시보드로 제공하는 사내 웹 애플리케이션입니다.
|
||||
|
||||
## 구성
|
||||
|
||||
- `frontend/`
|
||||
- 허브 화면과 공통 스타일
|
||||
- `frontend/apps/`
|
||||
- 화면별 source-of-truth 앱 소스
|
||||
- `legacy/static/`
|
||||
- 조직현황 레거시 런타임 자산
|
||||
- `incoming-files/served/`
|
||||
- integration 화면의 실제 런타임 서빙 자산
|
||||
- `incoming-files/reference/`
|
||||
- 원본 참고 자산
|
||||
- `backend/app/`
|
||||
- FastAPI 백엔드
|
||||
- `scripts/`
|
||||
- 실행, publish, 검증, 동기화 스크립트
|
||||
|
||||
## 핵심 원칙
|
||||
|
||||
- `frontend/apps/*`가 탭별 수정 원본입니다.
|
||||
- `incoming-files/served/*`와 `legacy/static/*`는 런타임 자산입니다.
|
||||
- 조직현황/멤버/자리배치 관련 검증은 `8081` 개발 환경에서 먼저 수행합니다.
|
||||
- `8080`은 기준 데이터와 공개 환경, `8081`은 검증 환경으로 다룹니다.
|
||||
|
||||
## 시작 문서
|
||||
|
||||
- 첫 문서: [docs/TEAM_GUIDE.md](docs/TEAM_GUIDE.md)
|
||||
- 협업 규칙: [CONTRIBUTING.md](CONTRIBUTING.md)
|
||||
- 개발/운영 DB 원칙: [docs/DEV_PROD_DB_PROTOCOL.md](docs/DEV_PROD_DB_PROTOCOL.md)
|
||||
- 실제 서빙 책임 맵: [docs/architecture/8081_SERVING_MAP.md](docs/architecture/8081_SERVING_MAP.md)
|
||||
- 디자인 기준: [docs/architecture/DESIGN_SSOT.md](docs/architecture/DESIGN_SSOT.md)
|
||||
|
||||
## 빠른 실행
|
||||
|
||||
기본 공개 환경:
|
||||
|
||||
```bash
|
||||
docker compose up -d --build
|
||||
```
|
||||
|
||||
격리된 `8081` 개발 환경:
|
||||
|
||||
```bash
|
||||
./scripts/prepare_dev_worktree.sh
|
||||
cd .dev-worktree-8081
|
||||
docker compose -p mh-dashboard-organization-dev --env-file .env -f docker-compose.8081.yml up -d --build
|
||||
```
|
||||
|
||||
## publish 스크립트
|
||||
|
||||
- 조직현황: `./scripts/publish_organization_app.sh`
|
||||
- 프로젝트별 분석: `./scripts/publish_payment_app.sh`
|
||||
- 팀/개인별 분석: `./scripts/publish_team_app.sh`
|
||||
- 사업관리대장: `./scripts/publish_ledger_app.sh`
|
||||
- DB 상태: `./scripts/publish_db_status_app.sh`
|
||||
Reference in New Issue
Block a user