docs: update project README
This commit is contained in:
1 parent
3176db8c48
commit
f62e0db849
4 files changed
+61
-34
No files matched your search
@@ -1,65 +1,92 @@
|
||||
# LOLYMPUS
|
||||
|
||||
리그 오브 레전드 내전을 운영하면서 필요한 일을 한 화면 안에 묶어둔 도구입니다. 참가자 모집, 팀 빌딩, 경매, 토너먼트 코드 배정, 결과 수집, 전적 확인까지 직접 운영하면서 반복해서 하던 작업을 줄이는 쪽에 맞춰 만들었습니다.
|
||||
|
||||
처음부터 범용 서비스로 만들었다기보다, 실제 커뮤니티에서 내전을 굴리면서 생긴 불편함을 하나씩 없애는 식으로 작업했습니다. 그래서 UI도 설명보다 운영 흐름을 먼저 보이게 두고, 관리자 화면과 참가자 화면을 분리해 필요한 정보만 빠르게 확인할 수 있게 구성했습니다.
|
||||
|
||||
## 화면
|
||||
|
||||
### 내전 목록
|
||||
|
||||

|
||||
|
||||
### 내전 상세 / 팀 편성
|
||||
## Overview
|
||||
|
||||
LOLYMPUS는 리그 오브 레전드 내전을 운영할 때 필요한 것들을 한곳에 모아둔 웹 애플리케이션입니다.
|
||||
|
||||
참가자 모집, 팀 편성, 경매, 토너먼트 코드 배정, 경기 결과 수집, 전적 확인처럼 운영자가 매번 손으로 챙기던 일을 줄이는 데 초점을 맞췄습니다. 처음부터 큰 서비스로 만들었다기보다는, 실제 커뮤니티 내전을 굴리면서 불편했던 부분을 하나씩 붙여가며 만든 프로젝트입니다.
|
||||
|
||||
## Purpose
|
||||
|
||||
내전은 사람만 모이면 끝나는 일이 아니었습니다. 참가자 티어를 확인하고, 포지션을 맞추고, 팀장을 정하고, 경기마다 토너먼트 코드를 나눠주고, 끝난 뒤 결과까지 정리해야 했습니다.
|
||||
|
||||
이 프로젝트는 그 흐름을 최대한 덜 번거롭게 만들기 위해 시작했습니다. 운영자는 전체 진행 상황을 보고, 참가자는 본인이 속한 팀과 다음 경기를 빠르게 확인할 수 있도록 구성했습니다.
|
||||
|
||||
## Screens
|
||||
|
||||
### Match detail
|
||||
|
||||

|
||||
|
||||
### 팀별 진행 페이지
|
||||
### Team progress
|
||||
|
||||

|
||||
|
||||
## 주요 기능
|
||||
## Functionalities
|
||||
|
||||
- 커뮤니티별 내전 생성, 수정, 모집, 참가자 관리
|
||||
- Riot 계정 연동, 티어/숙련도/최근 경기 기반 참가자 정보 표시
|
||||
- 팀장 선택과 포지션 기반 팀 빌딩
|
||||
- 다중 팀 내전, 라운드 로빈 경기 배정, 팀별 진행 페이지
|
||||
- 토너먼트 코드 풀 관리와 경기별 코드 배정
|
||||
- Match-V5 기반 결과 수집과 내전 전적 집계
|
||||
- 개인 전적, 커뮤니티 리더보드, 경기 상세 통계
|
||||
- Dakao/NATS 기반 커뮤니티 명령 처리
|
||||
**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 서버
|
||||
web/ React + Vite 프론트엔드
|
||||
scripts/ 운영/배포 보조 스크립트
|
||||
api/ NestJS API server
|
||||
web/ React + Vite client
|
||||
scripts/ deployment and maintenance scripts
|
||||
```
|
||||
|
||||
API 서버는 MongoDB, Garnet/Redis, NATS, Riot API를 사용합니다. 프론트엔드는 React Router와 TanStack Query를 중심으로 구성했고, 운영 화면은 최대한 빠르게 스캔할 수 있도록 단순한 테이블과 패널 위주로 만들었습니다.
|
||||
|
||||
## 로컬 실행
|
||||
## How to run
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
pnpm --filter api build
|
||||
pnpm start:api:dev
|
||||
pnpm dev:web
|
||||
```
|
||||
|
||||
웹 기본 환경값은 `apps/web/.env.development`를 사용합니다. API 쪽 로컬/운영 환경값은 `apps/project.env`와 외부 시크릿 설정을 함께 봅니다.
|
||||
웹 앱은 기본적으로 `apps/web/.env.development` 값을 사용합니다. API 환경값은 `apps/project.env`와 실행 환경의 시크릿 설정을 같이 확인합니다.
|
||||
|
||||
## 확인한 것
|
||||
## Checks
|
||||
|
||||
```bash
|
||||
pnpm --filter api test
|
||||
pnpm --filter web build:test
|
||||
```
|
||||
|
||||
현재 기준으로 API 테스트와 웹 테스트 빌드를 통과합니다.
|
||||
|
||||
## 메모
|
||||
|
||||
이 저장소는 개인 커뮤니티 운영 요구에 맞춰 빠르게 자란 코드라, 일반적인 SaaS 템플릿처럼 깔끔하게 분리된 제품은 아닙니다. 대신 실제 내전 운영에서 필요한 기능이 꽤 촘촘히 들어가 있습니다. 특히 토너먼트 코드, 팀별 진행 페이지, 결과 수집, 전적 집계 쪽은 운영하면서 손이 많이 가던 부분을 줄이는 데 초점을 뒀습니다.
|
||||
현재 정리된 기준으로 API 테스트와 웹 테스트 빌드를 통과합니다.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 54 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 88 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 54 KiB |
Reference in new issue
Block a user