SIMVEX(3D 시각화 기반 학습 솔루션) 프로젝트의 API 서버 및 DB 인프라 리포지토리입니다.
- Engine: Node.js / Express
- Database: PostgreSQL 15
- Ops: Docker, Docker Compose
현재 로컬 환경 포트 충돌 방지를 위해 아래와 같이 바인딩되어 있습니다.
- Backend API:
3000 - PostgreSQL (External):
5433(컨테이너 내부 포트는 5432)
| 타입 | 사용 상황 | 예시 |
|---|---|---|
| feat | 새로운 기능 개발 및 추가 | feat: 에셋 상세 조회 API 구현 |
| fix | 버그 수정 및 오류 해결 | fix: DB 연결 타임아웃 오류 수정 |
| docs | 문서 작업 (README, API 명세서 등) | docs: 커밋 컨벤션 가이드 추가 |
| style | 코드 의미에 영향 없는 변경 | style: 코드 포맷 수정 |
| refactor | 코드 리팩토링 | refactor: DB 조회 로직 모듈화 |
| chore | 빌드 설정, 패키지 설치 등 | chore: Dockerfile 수정 |
| test | 테스트 코드 작성 및 수정 | test: API 테스트 추가 |
루트 디렉토리에 .env 파일을 생성하고 아래 내용을 추가합니다.
DATABASE_URL=postgres://user:password123@db:5432/simvex_db
OPENAI_API_KEY=<openai_key_here>Swagger UI를 통해 AI Assist API를 직접 테스트해 볼 수 있으며, Model 및 Part 데이터의 상세 스키마를 확인할 수 있습니다.
- Local:
http://localhost:3000/api-docs - Production:
http://168.107.35.111:3000/api-docs