docs: update project documentation and agent routine guidelines
This commit is contained in:
parent
4cc14d8153
commit
122f20d031
|
|
@ -45,4 +45,4 @@ description: work routine
|
||||||
- 3단계 구현 및 테스트가 성공적으로 완료되면, 사용자에게 최종 보고하기 **전에 반드시 먼저** `<PROJECT_ROOT>/Docs/` 디렉토리에 작업 완료(Work done), 트러블슈팅(Troubleshooting), 의사 결정(Decisions made) 내역을 문서화해야 합니다.
|
- 3단계 구현 및 테스트가 성공적으로 완료되면, 사용자에게 최종 보고하기 **전에 반드시 먼저** `<PROJECT_ROOT>/Docs/` 디렉토리에 작업 완료(Work done), 트러블슈팅(Troubleshooting), 의사 결정(Decisions made) 내역을 문서화해야 합니다.
|
||||||
- 새 문서가 생성되거나 수정되면 자동으로 `Docs/index.md`에 문서의 색인(링크)을 추가합니다.
|
- 새 문서가 생성되거나 수정되면 자동으로 `Docs/index.md`에 문서의 색인(링크)을 추가합니다.
|
||||||
- 모든 코드 작업 내역과 의사 결정이 완전히 로컬 `Docs/`에 기록 및 정리된 후에만 비로소 "작업을 완료했다"고 사용자에게 알립니다.
|
- 모든 코드 작업 내역과 의사 결정이 완전히 로컬 `Docs/`에 기록 및 정리된 후에만 비로소 "작업을 완료했다"고 사용자에게 알립니다.
|
||||||
- 설치, 구동, 기능, 명령어 등을 위한 변경사항을 <PROJECT_ROOT>/README.md에 최신화합니다.
|
- 설치, 테스트 방법, 구동, 기능, 명령어 등을 위한 변경사항을 <PROJECT_ROOT>/README.md에 최신화합니다.
|
||||||
|
|
|
||||||
70
README.md
70
README.md
|
|
@ -1 +1,71 @@
|
||||||
# Kord
|
# Kord
|
||||||
|
|
||||||
|
Kord는 Discord 서버 관리를 돕는 강력하고 유연한 다기능 봇입니다.
|
||||||
|
|
||||||
|
## 1. 개요 (Overview)
|
||||||
|
|
||||||
|
**Kord**는 효율적인 서버 운영을 위해 설계된 Discord 봇입니다. TypeScript와 Discord.js를 기반으로 구축되었으며, Prisma(PostgreSQL)와 Redis를 활용하여 안정적이고 확장 가능한 아키텍처를 제공합니다. 임시 음성 채널 관리, 상세 감사 로그, 권한 진단 등의 핵심 기능을 통해 서버 관리자의 부담을 줄여줍니다.
|
||||||
|
|
||||||
|
## 2. 요구사항 (Requirements)
|
||||||
|
|
||||||
|
- **Runtime**: Node.js v20 이상
|
||||||
|
- **Package Manager**: Yarn v4 (Berry)
|
||||||
|
- **Database**: PostgreSQL (Prisma 사용)
|
||||||
|
- **Cache**: Redis (다중 인스턴스 동기화 및 캐싱)
|
||||||
|
- **Discord**: Bot Token 및 Client ID (Slash Command 등록용)
|
||||||
|
|
||||||
|
## 3. 테스트 방법 (Test Methods)
|
||||||
|
|
||||||
|
본 프로젝트는 Jest를 사용하여 유닛 테스트 및 통합 테스트를 수행합니다.
|
||||||
|
|
||||||
|
- **전체 테스트 실행**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
yarn test
|
||||||
|
```
|
||||||
|
|
||||||
|
- **i18n 번역 누락 확인**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
yarn check-i18n
|
||||||
|
```
|
||||||
|
|
||||||
|
## 4. 구동 방법 (Running Methods)
|
||||||
|
|
||||||
|
### 로컬 개발 환경
|
||||||
|
|
||||||
|
1. **의존성 설치**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
yarn install
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **환경 변수 설정**: `.env.example` 파일을 복사하여 `.env` 파일을 생성하고 필수 값을 입력합니다.
|
||||||
|
|
||||||
|
3. **데이터베이스 초기화**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx prisma migrate dev
|
||||||
|
npx prisma generate
|
||||||
|
```
|
||||||
|
|
||||||
|
4. **개발 서버 실행**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
yarn dev
|
||||||
|
```
|
||||||
|
|
||||||
|
### 프로덕션 환경
|
||||||
|
|
||||||
|
1. **빌드**: `yarn build`
|
||||||
|
2. **실행**: `yarn start`
|
||||||
|
3. **Docker**: `docker-compose up -d`를 통해 전체 스택(Bot, DB, Redis)을 실행할 수 있습니다.
|
||||||
|
|
||||||
|
## 5. 기능 목록 (Feature List)
|
||||||
|
|
||||||
|
- **임시 음성 채널 (Voice)**: 생성기(Generator) 채널을 통해 동적인 음성 채널 생성 및 관리 기능을 제공합니다.
|
||||||
|
- **감사 로그 (Audit Log)**: 서버 내 주요 이벤트를 카테고리별(VOICE, PERMISSION, SYSTEM 등)로 세분화하여 기록합니다.
|
||||||
|
- **서버 설정 (Config)**: 따라하기(Mimic), 큰 이모지(Big Emoji) 등 봇의 기능을 서버별 환경에 맞게 토글하거나 설정할 수 있습니다.
|
||||||
|
- **권한 감사 (Permission Audit)**: 봇의 정상 작동을 방해하는 권한 문제를 즉시 진단하고 해결 방법을 안내합니다.
|
||||||
|
- **초기 설정 마법사 (Setup Wizard)**: 봇 도입 초기 기능을 한눈에 설정할 수 있는 직관적인 UI를 제공합니다.
|
||||||
|
- **다국어 지원 (i18n)**: 한국어와 영어를 포함한 다국어 환경을 지원합니다.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue