1f91bfb9bf
# Conflicts: # package.json # yarn.lock |
||
|---|---|---|
| .agents/rules | ||
| Docs | ||
| prisma | ||
| scripts | ||
| src | ||
| tests | ||
| .cursorrules | ||
| .editorconfig | ||
| .env.example | ||
| .eslintrc.js | ||
| .gitattributes | ||
| .gitignore | ||
| .prettierrc | ||
| .windsurfrules | ||
| .yarnrc.yml | ||
| Dockerfile | ||
| README.md | ||
| docker-compose.yml | ||
| jest.config.js | ||
| package.json | ||
| tsconfig.json | ||
| yarn.lock | ||
README.md
Kord
Kord는 Discord 서버 관리를 돕는 강력하고 유연한 다기능 봇입니다.
1. 개요 (Overview)
Kord는 효율적인 서버 운영을 위해 설계된 Discord 봇입니다. TypeScript와 Discord.js를 기반으로 구축되었으며, Prisma(PostgreSQL)를 활용하여 안정적이고 확장 가능한 아키텍처를 제공합니다. 임시 음성 채널 관리, 상세 감사 로그, 권한 진단 등의 핵심 기능을 통해 서버 관리자의 부담을 줄여줍니다.
2. 요구사항 (Requirements)
- Runtime: Node.js v20 이상
- Package Manager: Yarn v4 (Berry)
- Database: PostgreSQL (Prisma 사용)
- Discord: Bot Token 및 Client ID (Slash Command 등록용)
3. 테스트 방법 (Test Methods)
본 프로젝트는 Jest를 사용하여 유닛 테스트 및 통합 테스트를 수행합니다.
-
전체 테스트 실행:
yarn test -
i18n 번역 누락 확인:
yarn check-i18n
4. 구동 방법 (Running Methods)
로컬 개발 환경
-
의존성 설치:
yarn install -
환경 변수 설정:
.env.example파일을 복사하여.env파일을 생성하고 필수 값을 입력합니다. -
데이터베이스 초기화:
npx prisma migrate dev npx prisma generate -
개발 서버 실행:
yarn dev
프로덕션 환경
- 빌드:
yarn build - 실행:
yarn start - Docker:
docker-compose up -d를 통해 전체 스택(Bot, DB)을 실행할 수 있습니다.
5. 기능 목록 (Feature List)
- 임시 음성 채널 (Voice): 생성기(Generator) 채널을 통해 동적인 음성 채널 생성 및 관리 기능을 제공합니다.
- 감사 로그 (Audit Log): 서버 내 주요 이벤트를 카테고리별(VOICE, PERMISSION, SYSTEM 등)로 세분화하여 기록합니다.
- 서버 설정 (Config): 따라하기(Mimic), 큰 이모지(Big Emoji) 등 봇의 기능을 서버별 환경에 맞게 토글하거나 설정할 수 있습니다.
- 권한 감사 (Permission Audit): 봇의 정상 작동을 방해하는 권한 문제를 즉시 진단하고 해결 방법을 안내합니다.
- 초기 설정 마법사 (Setup Wizard): 봇 도입 초기 기능을 한눈에 설정할 수 있는 직관적인 UI를 제공합니다.
- 다국어 지원 (i18n): 한국어와 영어를 포함한 다국어 환경을 지원합니다.