e499c79464
- config: 기본값 삭제(설정이 없으면 슈퍼어드민 없음) - 테스트·E2E: 만든 ID(900000000000000001/2) 사용 - 문서·README·.env.example·관리자 화면 입력 예시에서 실제 ID 삭제 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
45 lines
2.5 KiB
Markdown
45 lines
2.5 KiB
Markdown
# 같이 놀자 보드게임
|
|
|
|
광고 없이 가볍고, 링크 하나로 친구·가족과 바로 즐기는 온라인 보드게임 사이트.
|
|
계획서는 [docs/](docs/README.md)에 있고, 구현은 계획서를 따른다.
|
|
|
|
## 개발
|
|
```bash
|
|
bun install
|
|
bun run --filter '@bg/server' dev # 서버 :3000
|
|
bun run --filter '@bg/web' dev # 웹 :5173 (API/WS는 :3000으로 프록시)
|
|
```
|
|
브라우저에서 http://localhost:5173 을 연다. 디스코드 값이 없으면 게스트 로그인만 보인다.
|
|
|
|
## 확인
|
|
```bash
|
|
bun run typecheck
|
|
bun run test # 규칙·서버 통합·방 단위 테스트 (4개 병렬, 무작위 대국은 시드 1/10만, 1분 안쪽)
|
|
bun run test:full # 배포 전 전체: 무작위 대국 시드 전부(1,000개 등), 순차 실행이라 10분쯤
|
|
(cd apps/web && bunx vite build) # 웹 빌드
|
|
bun e2e/omok.e2e.ts # 브라우저 두 개로 오목 한 판 (Chrome 필요)
|
|
bun e2e/admin.e2e.ts # 관리자: 슈퍼어드민 로그인 → 규칙 변경·잠금 → 새 방 반영
|
|
bun e2e/games.e2e.ts [게임id...] # 게임별: 방 만들기 → 친구 입장 → 실제 화면 조작으로 여러 턴(일부는 끝까지)
|
|
bun e2e/a11y.e2e.ts # 접근성(axe) 검사
|
|
bun e2e/pwa.e2e.ts # PWA: 매니페스트·아이콘, 서비스 워커, 오프라인 안내, 홈 화면에 추가
|
|
bun scripts/loadtest.ts --help # 부하·장애 주입 (docs/reports 참고)
|
|
```
|
|
|
|
## 배포
|
|
`deploy/.env.example`을 `deploy/.env`로 복사해 값을 채운 뒤:
|
|
```bash
|
|
cd deploy && docker compose up -d --build
|
|
```
|
|
이미 HTTPS 리버스 프록시가 있는 서버(지금 운영 중인 .5 + NPMplus)에서는 `docker compose -f docker-compose.proxy.yml up -d --build`로 앱만 띄운다.
|
|
자세한 절차는 [docs/11-deployment-ops.md](docs/11-deployment-ops.md).
|
|
|
|
## 관리자
|
|
`/admin`. 슈퍼어드민은 서버의 `deploy/.env`에 있는 환경 변수 `SUPERADMIN_DISCORD_IDS`의 디스코드 ID(저장소에는 넣지 않음), 어드민은 관리자 화면에서 디스코드 ID로 추가한다. 자세한 내용은 [docs/14-admin.md](docs/14-admin.md).
|
|
|
|
## 구조
|
|
- `packages/engine` — 게임 공통 타입, 시드 난수, 테스트 도구
|
|
- `packages/shared` — 프로토콜, 닉네임·방 코드 규칙, 게임 목록 (`/lite`는 브라우저용)
|
|
- `packages/games/<id>` — 게임 규칙(순수 함수)
|
|
- `apps/server` — Bun 서버(HTTP API, WebSocket, 방 관리, SQLite)
|
|
- `apps/web` — React 웹
|