diff --git a/.gitignore b/.gitignore index 605b62c2..40352655 100644 --- a/.gitignore +++ b/.gitignore @@ -24,6 +24,7 @@ website/LICENSE *.temp.MD *.md +!README.md /tmp/ /user-game-history/ /*.txt diff --git a/README.md b/README.md new file mode 100644 index 00000000..550addde --- /dev/null +++ b/README.md @@ -0,0 +1,65 @@ +# LOLYMPUS + +리그 오브 레전드 내전을 운영하면서 필요한 일을 한 화면 안에 묶어둔 도구입니다. 참가자 모집, 팀 빌딩, 경매, 토너먼트 코드 배정, 결과 수집, 전적 확인까지 직접 운영하면서 반복해서 하던 작업을 줄이는 쪽에 맞춰 만들었습니다. + +처음부터 범용 서비스로 만들었다기보다, 실제 커뮤니티에서 내전을 굴리면서 생긴 불편함을 하나씩 없애는 식으로 작업했습니다. 그래서 UI도 설명보다 운영 흐름을 먼저 보이게 두고, 관리자 화면과 참가자 화면을 분리해 필요한 정보만 빠르게 확인할 수 있게 구성했습니다. + +## 화면 + +### 내전 목록 + +![LOLYMPUS match list](docs/screenshots/lolympus-match-list.png) + +### 내전 상세 / 팀 편성 + +![LOLYMPUS match detail](docs/screenshots/lolympus-match-detail.png) + +### 팀별 진행 페이지 + +![LOLYMPUS team progress](docs/screenshots/lolympus-team-progress.png) + +## 주요 기능 + +- 커뮤니티별 내전 생성, 수정, 모집, 참가자 관리 +- Riot 계정 연동, 티어/숙련도/최근 경기 기반 참가자 정보 표시 +- 팀장 선택과 포지션 기반 팀 빌딩 +- 다중 팀 내전, 라운드 로빈 경기 배정, 팀별 진행 페이지 +- 토너먼트 코드 풀 관리와 경기별 코드 배정 +- Match-V5 기반 결과 수집과 내전 전적 집계 +- 개인 전적, 커뮤니티 리더보드, 경기 상세 통계 +- Dakao/NATS 기반 커뮤니티 명령 처리 + +## 구성 + +```text +apps/ + api/ NestJS API 서버 + web/ React + Vite 프론트엔드 +scripts/ 운영/배포 보조 스크립트 +``` + +API 서버는 MongoDB, Garnet/Redis, NATS, Riot API를 사용합니다. 프론트엔드는 React Router와 TanStack Query를 중심으로 구성했고, 운영 화면은 최대한 빠르게 스캔할 수 있도록 단순한 테이블과 패널 위주로 만들었습니다. + +## 로컬 실행 + +```bash +pnpm install +pnpm --filter api build +pnpm start:api:dev +pnpm dev:web +``` + +웹 기본 환경값은 `apps/web/.env.development`를 사용합니다. API 쪽 로컬/운영 환경값은 `apps/project.env`와 외부 시크릿 설정을 함께 봅니다. + +## 확인한 것 + +```bash +pnpm --filter api test +pnpm --filter web build:test +``` + +현재 기준으로 API 테스트와 웹 테스트 빌드를 통과합니다. + +## 메모 + +이 저장소는 개인 커뮤니티 운영 요구에 맞춰 빠르게 자란 코드라, 일반적인 SaaS 템플릿처럼 깔끔하게 분리된 제품은 아닙니다. 대신 실제 내전 운영에서 필요한 기능이 꽤 촘촘히 들어가 있습니다. 특히 토너먼트 코드, 팀별 진행 페이지, 결과 수집, 전적 집계 쪽은 운영하면서 손이 많이 가던 부분을 줄이는 데 초점을 뒀습니다.