docs: refresh readme for release 77

This commit is contained in:
dahyeon committed 2026-06-09 06:17:45 -07:00
1 parent e7eaa4f67d
commit 168e0eca66
10 files changed
+562 -62

No files matched your search

+81 -61
View File
@@ -1,56 +1,80 @@
# LOLYMPUS
![LOLYMPUS match list](docs/screenshots/lolympus-match-list.png)
LOLYMPUS는 리그 오브 레전드 커뮤니티의 여러 이벤트 중 내전(사용자 설정 게임)을 운영할 때 필요한 일정 관리, 참여자 모집, 팀 빌딩, 토너먼트 코드 배정, 경기 진행, 실시간 라이브 방송(추후 지원 예정), 결과 수집, 전적 확인을 한곳에서 처리하기 위한 웹 애플리케이션입니다.
## Overview
<p align="center">
<a href="docs/screenshots/lolympus-demo.mp4">
<img src="docs/screenshots/lolympus-auction.png" alt="LOLYMPUS 경매 팀빌딩 대표 화면" width="960">
</a>
</p>
LOLYMPUS는 리그 오브 레전드 내전을 운영할 때 필요한 것들을 한곳에 모아둔 웹 애플리케이션입니다.
<p align="center">
<a href="docs/screenshots/lolympus-demo.mp4">3초 간격 데모 영상 보기</a>
</p>
참가자 모집, 팀 편성, 경매, 토너먼트 코드 배정, 경기 결과 수집, 전적 확인처럼 운영자가 매번 손으로 챙기던 일을 줄이는 데 초점을 맞췄습니다. 처음부터 큰 서비스로 만들었다기보다는, 실제 커뮤니티 내전을 굴리면서 불편했던 부분을 하나씩 붙여가며 만든 프로젝트입니다.
## 배포 주소
## Purpose
| Environment | Version | URL |
| ----------- | ------- | -------------------------------------- |
| Production | v77 | <https://lolympus.dahyeon.us/> |
| Staging | v77 | <https://890c50be.lolympus.pages.dev/> |
내전은 사람만 모이면 끝나는 일이 아니었습니다. 참가자 티어를 확인하고, 포지션을 맞추고, 팀장을 정하고, 경기마다 토너먼트 코드를 나눠주고, 끝난 뒤 결과까지 정리해야 했습니다.
## 개요
이 프로젝트는 그 흐름을 최대한 덜 번거롭게 만들기 위해 시작했습니다. 운영자는 전체 진행 상황을 보고, 참가자는 본인이 속한 팀과 다음 경기를 빠르게 확인할 수 있도록 구성했습니다.
내전 운영은 사람을 모으는 것에서 끝나지 않습니다. 참가자의 티어와 포지션을 확인하고, 팀장을 정하고, 팀을 나누고, 경기마다 토너먼트 코드를 전달하고, 끝난 뒤 결과와 전적까지 정리해야 합니다.
## Screens
LOLYMPUS는 이 반복 작업을 줄이는 데 초점을 맞췄습니다. 운영자는 전체 진행 상황을 한눈에 보고, 참가자는 카카오톡 연동을 통해 쉽게 일정 확인/참가 신청하고 본인이 속한 팀과 다음 경기 정보를 빠르게 확인할 수 있습니다.
### Match detail
## 워크플로우
![LOLYMPUS match detail](docs/screenshots/lolympus-match-detail.png)
1. **내전 개설과 모집**
내전 일정, 진행 방식, 정원, 공지사항을 등록하고 참가 신청 현황을 확인합니다.
### Team progress
2. **참가자 정보 확인**
Riot 계정 기반으로 소환사명, 태그, 프로필 아이콘, 솔로랭크/자유랭크 티어, 선호 포지션을 보여줍니다.
![LOLYMPUS team progress](docs/screenshots/lolympus-team-progress.png)
3. **팀 빌딩과 경매**
팀장을 기준으로 팀을 구성하거나, 경매 방식으로 참가자를 배정합니다. 현재 입찰가, 팀별 포인트, 낙찰 기록을 함께 관리합니다.
## Functionalities
4. **팀별 진행 페이지**
각 팀은 예정 경기, 상대 팀, 라인업, 토너먼트 코드를 한 화면에서 확인하고 복사할 수 있습니다.
**1. 내전 관리**
내전 생성, 수정, 모집 상태 변경, 참가자 목록 확인을 할 수 있습니다.
5. **결과 수집과 통계**
Riot Match-V5 데이터를 이용해 경기 결과를 수집하고, 소환사별 전적과 커뮤니티 리더보드를 제공합니다.
**2. 참가자 정보 관리**
Riot 계정 정보를 기반으로 소환사명, 태그, 프로필 아이콘, 솔로랭크/자유랭크 티어, 선호 포지션을 보여줍니다.
## 스크린샷
**3. 팀 빌딩**
팀장을 정하고 포지션을 맞춰 팀을 구성합니다. 여러 팀이 참여하는 내전도 처리할 수 있습니다.
상단의 경매 화면은 LOLYMPUS가 단순 참가자 목록을 넘어서 실제 팀빌딩 운영까지 다루는 대표 화면입니다. 3초 간격 데모 영상은 위 대표 이미지를 클릭해서 확인할 수 있고, 세부 화면은 아래 PNG 원본을 기준으로 볼 수 있습니다.
**4. 경매 진행**
팀장 경매 방식으로 참가자를 뽑을 수 있고, 현재 입찰가와 낙찰 기록을 관리합니다.
| 경매 팀빌딩 |
| ----------------------------------------------------------------------------------------------------------------------------------------- |
| <a href="docs/screenshots/lolympus-demo.mp4"><img src="docs/screenshots/lolympus-auction.png" alt="LOLYMPUS 경매 팀빌딩" width="840"></a> |
**5. 토너먼트 코드 관리**
업로드한 토너먼트 코드를 경기별로 배정하고, 팀별 진행 페이지에서 바로 복사할 수 있게 했습니다.
| 내전 목록 | 모집 상세 |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| <img src="docs/screenshots/lolympus-match-list.png" alt="LOLYMPUS 내전 목록" width="420"> | <img src="docs/screenshots/lolympus-match-recruiting.png" alt="LOLYMPUS 모집 상세" width="420"> |
**6. 팀별 진행 페이지**
각 팀이 자기 경기 일정, 상대 팀, 토너먼트 코드, 종료된 경기 결과를 한 화면에서 확인할 수 있습니다.
| 단판 경기 결과 | 개인 전적 |
| ------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------- |
| <img src="docs/screenshots/lolympus-match-result(pair).png" alt="LOLYMPUS 단판 경기 결과" width="420"> | <img src="docs/screenshots/lolympus-player-stats.png" alt="LOLYMPUS 소환사 전적" width="420"> |
**7. 전적 수집과 통계**
Riot Match-V5 데이터를 이용해 내전 결과를 수집하고, 개인 전적과 커뮤니티 리더보드를 보여줍니다.
| 경기 상세 |
| ------------------------------------------------------------------------------------------- |
| <img src="docs/screenshots/lolympus-match-detail.png" alt="LOLYMPUS 경기 상세" width="840"> |
**8. 커뮤니티 명령 연동**
Dakao/NATS 기반 명령을 받아 참가 신청이나 운영 흐름과 연결할 수 있도록 구성했습니다.
## 기능
## Used technologies
- 내전 생성, 수정, 모집 상태 변경, 참가자 목록 확인
- 카카오톡 명령어를 통한 일정 조회, 내전 참가, 취소, 계정 등록 등 기능 제공
- Riot 계정 기반 참가자 프로필, 티어, 포지션 확인
- 팀장 지정, 포지션 기반 팀 구성, 다팀 내전 지원
- 팀장 경매 방식의 참가자 낙찰과 입찰 기록 관리
- 경기별 토너먼트 코드 배정과 팀별 복사 UI
- 팀별 경기 일정, 상대 팀, 라인업, 결과 확인
- Riot Match-V5 기반 결과 수집, 개인 전적, 리더보드 제공
- Dakao/NATS 기반 커뮤니티 명령 연동
## 기술 스택
- React
- Vite
@@ -62,53 +86,49 @@ Dakao/NATS 기반 명령을 받아 참가 신청이나 운영 흐름과 연결
- NATS
- Riot API
- pnpm workspace
- Kubernetes
- ArgoCD
## Project structure
## 디렉터리 구조
```text
apps/
api/ NestJS API server
web/ React + Vite client
scripts/ deployment and maintenance scripts
docs/
screenshots/ README and project screenshots
scripts/ deployment and maintenance scripts
```
## How to run
## 사전 요구사항
- Node.js 24 이상
- pnpm 10.4.1 (`packageManager` 기준, `corepack enable`로 활성화 권장)
- MongoDB 7.0, Redis 5.0 이상, NATS 실행 환경
## 실행 방법
```bash
pnpm install
pnpm start:api:dev
pnpm dev:web
pnpm start:web:dev
```
웹 앱은 기본적으로 `apps/web/.env.development` 값을 사용합니다. API 환경값은 `apps/project.env`와 실행 환경의 시크릿 설정을 같이 확인합니다.
웹 앱은 기본적으로 `apps/web/.env.development` 값을 사용합니다. API 환경값은 `apps/project.env`와 실행 환경의 시크릿 설정을 함께 확인합니다.
## Checks
카카오톡 기반 명령어 기능은 Dakao(커스텀 카카오톡 게이트웨이) 연동이 필요합니다. Dakao가 실행 중이 아니거나 NATS를 통해 API 서버와 연결되어 있지 않으면 일정 조회, 내전 참가, 참가 취소, 계정 등록 같은 카카오톡 명령어는 사용할 수 없습니다.
```bash
pnpm --filter api test
pnpm --filter web build:staging
```
## 커맨드
현재 정리된 기준으로 API 테스트와 웹 테스트 빌드를 통과합니다.
| Command | Description |
| --------------------------------- | -------------------------------- |
| `pnpm start:web:dev` | 웹 앱 개발 서버 실행 |
| `pnpm start:api:dev` | API 서버 dev 환경 실행 |
| `pnpm --filter api test` | API 테스트 실행 |
| `pnpm --filter web build:staging` | 웹 staging 빌드 검증 |
| `pnpm deploy:web:staging` | Cloudflare Pages staging 배포 |
| `pnpm deploy:web:prod` | Cloudflare Pages production 배포 |
## 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`로 지정합니다.
This project is licensed under the GNU Library General Public License v2.0. See [LICENSE](LICENSE) for details.