Files
lolympus-tournament-support/README.md
T

115 lines
4.3 KiB
Markdown

# LOLYMPUS
![LOLYMPUS match list](docs/screenshots/lolympus-match-list.png)
## Overview
LOLYMPUS는 리그 오브 레전드 내전을 운영할 때 필요한 것들을 한곳에 모아둔 웹 애플리케이션입니다.
참가자 모집, 팀 편성, 경매, 토너먼트 코드 배정, 경기 결과 수집, 전적 확인처럼 운영자가 매번 손으로 챙기던 일을 줄이는 데 초점을 맞췄습니다. 처음부터 큰 서비스로 만들었다기보다는, 실제 커뮤니티 내전을 굴리면서 불편했던 부분을 하나씩 붙여가며 만든 프로젝트입니다.
## Purpose
내전은 사람만 모이면 끝나는 일이 아니었습니다. 참가자 티어를 확인하고, 포지션을 맞추고, 팀장을 정하고, 경기마다 토너먼트 코드를 나눠주고, 끝난 뒤 결과까지 정리해야 했습니다.
이 프로젝트는 그 흐름을 최대한 덜 번거롭게 만들기 위해 시작했습니다. 운영자는 전체 진행 상황을 보고, 참가자는 본인이 속한 팀과 다음 경기를 빠르게 확인할 수 있도록 구성했습니다.
## Screens
### Match detail
![LOLYMPUS match detail](docs/screenshots/lolympus-match-detail.png)
### Team progress
![LOLYMPUS team progress](docs/screenshots/lolympus-team-progress.png)
## Functionalities
**1. 내전 관리**
내전 생성, 수정, 모집 상태 변경, 참가자 목록 확인을 할 수 있습니다.
**2. 참가자 정보 관리**
Riot 계정 정보를 기반으로 소환사명, 태그, 프로필 아이콘, 솔로랭크/자유랭크 티어, 선호 포지션을 보여줍니다.
**3. 팀 빌딩**
팀장을 정하고 포지션을 맞춰 팀을 구성합니다. 여러 팀이 참여하는 내전도 처리할 수 있습니다.
**4. 경매 진행**
팀장 경매 방식으로 참가자를 뽑을 수 있고, 현재 입찰가와 낙찰 기록을 관리합니다.
**5. 토너먼트 코드 관리**
업로드한 토너먼트 코드를 경기별로 배정하고, 팀별 진행 페이지에서 바로 복사할 수 있게 했습니다.
**6. 팀별 진행 페이지**
각 팀이 자기 경기 일정, 상대 팀, 토너먼트 코드, 종료된 경기 결과를 한 화면에서 확인할 수 있습니다.
**7. 전적 수집과 통계**
Riot Match-V5 데이터를 이용해 내전 결과를 수집하고, 개인 전적과 커뮤니티 리더보드를 보여줍니다.
**8. 커뮤니티 명령 연동**
Dakao/NATS 기반 명령을 받아 참가 신청이나 운영 흐름과 연결할 수 있도록 구성했습니다.
## Used technologies
- React
- Vite
- TypeScript
- TanStack Query
- NestJS
- MongoDB
- Redis/Garnet
- NATS
- Riot API
- pnpm workspace
## Project structure
```text
apps/
api/ NestJS API server
web/ React + Vite client
scripts/ deployment and maintenance scripts
```
## How to run
```bash
pnpm install
pnpm start:api:dev
pnpm dev:web
```
웹 앱은 기본적으로 `apps/web/.env.development` 값을 사용합니다. API 환경값은 `apps/project.env`와 실행 환경의 시크릿 설정을 같이 확인합니다.
## Checks
```bash
pnpm --filter api test
pnpm --filter web build:staging
```
현재 정리된 기준으로 API 테스트와 웹 테스트 빌드를 통과합니다.
## Deployment branches
`main`은 항상 배포 가능한 trunk로 유지하고 dev 배포 기준으로 사용합니다.
빌드 번호는 `BUILD_NUMBER` 파일에서 1씩 증가시키며, 현재 시작 번호는 `66`입니다.
staging 검증이 필요할 때는 `release/66` 같은 임시 브랜치를 만들고,
검증이 끝나면 삭제합니다.
```bash
git push origin main:release/66
pnpm deploy:web:staging
```
staging/prod Pages 배포 스크립트는 명시 릴리즈 브랜치 환경변수가 있으면 그
값을 사용하고, 없으면 최신 `release/*` 브랜치를 자동으로 선택합니다. 최신
기준은 브랜치가 가리키는 커밋 시각이며, 동률이면 브랜치명 내림차순입니다.
staging은 선택된 릴리즈 브랜치로 preview 배포를 만들고, prod는 Cloudflare
Pages production branch로 업로드해 production 배포를 만듭니다.
명시 릴리즈 브랜치는 staging은 `CF_PAGES_STAGING_BRANCH`, prod는
`CF_PAGES_RELEASE_BRANCH`로 지정합니다. Cloudflare Pages production branch가
`main`이 아니면 `CF_PAGES_PRODUCTION_BRANCH`로 지정합니다.