generated from ttipo/project-base
ttipo
0c3238936a
메일 16단계(개인 설정)의 서버다. - 주소록: POST /api/contact-import-checks · contact-imports · contact-deletions 로 여러 명을 한 번에 확인 · 만들기 · 지우기(화면이 준 uid 로 다시 보내도 두 번 들어가지 않는다), GET /api/contact-exports 로 vCard 3.0 · CSV(BOM · 한국어 머리 · 수식 막기) 내보내기 — 하나씩 만들면 사무실 요청 수 한도에 걸린다. - 여러 서명: /api/mail-signatures · /api/mail-signature-defaults, 서명마다 한 줄로 바꾸는 마이그레이션 (지금 서명은 "기본 서명"으로 — 값 보존), 그림 정리는 모든 서명의 합집합. 옛 /api/mail-signature 는 앱 첫 판을 위해 그대로. - 부재중: 서식 본문(multipart — 문자열 4,096바이트는 variables 조각으로)과 회사 밖 응답(봉투 도메인으로 가름 — 답장도 그 주소로만), 원본 판 3 은 새 칸을 쓴 직원만. - 2단계 인증: 켠 채 휴대폰 바꾸기(새 코드 확인 → 지금 코드 · 비밀번호로 엔진 요청 하나 — 꺼지는 틈 없음). 새 에러 코드 · 새 의존성 없음. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
backend — ARA SYSTEM API (NestJS)
웹 · 앱이 함께 쓰는 REST API 다(/api). 메일 엔진(Stalwart)을 JMAP 으로 감싸고, 로그인 세션 · 설정 · 검색 색인 · 앱 알림 · 대용량 첨부 · 운영 도구를 맡는다.
- 모듈 지도 · 개발 규칙:
.claude/skills/nestjs/SKILL.md - API 약속(웹 · 앱과 함께):
docs/mail/api-contract.md - 공통 규칙(응답 꼴 · 에러 코드 · 로그 · 보안):
CLAUDE.md
실행 — 컨테이너로
백엔드는 늘 컨테이너로 띄운다. 의존성 · lock 이 Linux 기준이라 호스트에서 npm install 하지 않는다(바꿀 때도 컨테이너 안에서 — nestjs 스킬 "의존성 추가/제거").
# 저장소 루트에서 — 개발 스택(backend + db + 메일 엔진)
docker compose -f docker-compose.yml -f docker-compose.dev.yml --env-file .env.development up -d
docker compose -f docker-compose.yml -f docker-compose.dev.yml --env-file .env.development logs -f backend
- 처음 띄우면 마이그레이션을 한 번 돌리고 watch 빌드를 시작한다(Windows 바인드 마운트라 수십 분 걸릴 수 있다). 코드를 고치면 저절로 다시 뜬다.
- Swagger: http://localhost:3000/api-docs
시험 · 검사
docker exec arasystem-backend npm run lint # 경고 0
docker exec arasystem-backend npm run test # 단위 — 메모리가 빠듯하면 -- --maxWorkers=2
docker exec arasystem-backend npx jest --config ./test/jest-e2e.json # e2e — DB · 메일 엔진 필요
컨테이너 이름은 <PROJECT_NAME>-backend(개발 기본 arasystem). Git Bash 에서 컨테이너 안 경로를 줄 때는 MSYS_NO_PATHCONV=1 을 붙인다.
자주 하는 일
- 에러 코드:
src/common/errors/error-codes.ts만 고치고 호스트에서cd backend && npm run sync:error-codes(웹 · 앱 사전이 함께 바뀐다). - DB 스키마: 엔티티를 고친 뒤
docker exec arasystem-backend npm run migration:generate -- src/migrations/<이름>→ 만든 SQL 을 눈으로 확인 → 엔티티와 함께 커밋(nestjs 스킬 "DB 마이그레이션"). - 운영 도구(운영 서버 안 명령 — 입사 · 비밀번호 재설정 · 휴대폰 앱 올리기 등):
sudo docker exec -it <PROJECT_NAME>-backend node dist/cli/ops.js— 계약 6절 · mail/README.