설치 가이드
이 가이드는 플랫폼을 빠르게 설치하고 구성하는 데 도움이 됩니다.
시스템 요구사항
최소 요구사항
- Node.js: 18.0.0 이상
- npm: 8.0.0 이상
- pnpm: 8.0.0 이상 (권장)
- 메모리: 4GB RAM
- 저장소: 2GB 사용 가능한 공간
권장 구성
- Node.js: 20.0.0 이상
- 메모리: 8GB RAM
- 저장소: 5GB 사용 가능한 공간
- 운영체제: macOS 12+, Ubuntu 20.04+, Windows 10+
설치 단계
1. 프로젝트 클론
git clone https://github.com/your-org/woker-job.git
cd woker-job
2. 의존성 설치
pnpm 사용 (권장):
pnpm install
또는 npm 사용:
npm install
3. 환경 구성
환경 변수 파일 복사:
cp .env.example .env
.env
파일을 편집하여 필요한 환경 변수를 구성:
# 데이터베이스 구성
DATABASE_URL="postgresql://username:password@localhost:5432/woker_job"
# JWT 시크릿
JWT_SECRET="your-jwt-secret-key"
# 프론트엔드 구성
NUXT_PUBLIC_FRONTEND_BASE_URL="http://localhost:3000"
NUXT_PUBLIC_BACKEND_BASE_URL="http://localhost:3001"
4. 데이터베이스 설정
Docker 사용 (권장)
# PostgreSQL 데이터베이스 시작
docker run --name woker-job-db \
-e POSTGRES_DB=woker_job \
-e POSTGRES_USER=postgres \
-e POSTGRES_PASSWORD=password \
-p 5432:5432 \
-d postgres:15
수동 PostgreSQL 설치
- PostgreSQL 다운로드 및 설치
- 데이터베이스 생성:
CREATE DATABASE woker_job;
CREATE USER woker_user WITH PASSWORD 'your_password';
GRANT ALL PRIVILEGES ON DATABASE woker_job TO woker_user;
5. 데이터베이스 마이그레이션 실행
# 백엔드 디렉토리로 이동
cd apps/back-end
# 마이그레이션 실행
pnpm run migration:run
6. 개발 서버 시작
모든 서비스 시작 (권장)
프로젝트 루트에서:
pnpm run dev
서비스별 시작
백엔드 서비스:
cd apps/back-end
pnpm run start:dev
프론트엔드 서비스:
cd apps/web
pnpm run dev
7. 설치 확인
- 프론트엔드 애플리케이션 접속: http://localhost:3000
- 백엔드 API 접속: http://localhost:3001
- API 문서 확인: http://localhost:3001/api
프로덕션 환경 배포
Docker 배포
- 이미지 빌드:
docker build -t woker-job .
- 컨테이너 실행:
docker run -d \
--name woker-job \
-p 3000:3000 \
-p 3001:3001 \
-e DATABASE_URL="your-production-db-url" \
woker-job
수동 배포
- 프로덕션 버전 빌드:
pnpm run build
- 프로덕션 서비스 시작:
pnpm run start
일반적인 문제
포트 충돌
포트 3000 또는 3001이 사용 중인 경우 환경 변수를 수정할 수 있습니다:
# 프론트엔드 포트
PORT=3002
# 백엔드 포트
BACKEND_PORT=3003
데이터베이스 연결 실패
- 데이터베이스 서비스가 실행 중인지 확인
- 연결 문자열 형식 확인
- 방화벽 설정 확인
의존성 설치 실패
- 캐시 정리:
pnpm store prune
npm cache clean --force
- node_modules 삭제 후 재설치:
rm -rf node_modules
pnpm install
다음 단계
설치 완료 후 다음을 수행할 수 있습니다:
도움 받기
설치 중 문제가 발생한 경우:
- 문제 해결 가이드 확인
- GitHub Issues 확인
- 기술 지원 팀에 문의