Files
ai-dev-portal/CLAUDE.md
Hyemin Lee d889a8516f docs: 기획서(PRD)와 프로젝트 작업 지침(CLAUDE.md) 추가
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-29 17:11:32 +09:00

3.8 KiB

CLAUDE.md

AI DEV — 사내 개발 포털. 직원이 한 곳에서 사내 개발 사이트로 이동하고, 만든 프로젝트를 공유·코멘트하는 곳. Keycloak SSO(사번 로그인) + Node(Express+EJS) + Postgres.

이 저장소를 다룰 때 (먼저 읽기)

  • 사용자는 개발 전문가가 아닌 사내 IT 기획자/직원이다. 변경은 단순하게 유지한다.
    • 빌드 단계·프런트엔드 프레임워크(React 등)·번들러 도입 금지. 서버 렌더링(EJS) + 단일 CSS 유지.
    • 새 npm 의존성은 꼭 필요할 때만, 이유와 함께 추가한다.
  • UI 문구와 코드 주석은 한국어로 쓴다.
  • 비밀값은 코드에 넣지 않는다. 환경변수(.project-env 로컬 / Kubero Env 배포)로만 다룬다.
  • 할 일·작업 단위는 PLANS.md, 디자인 방향은 design-refs/ 참고.

스택

  • Node 22 ESM ("type": "module") — import 경로에 .js 확장자 필수.
  • Express 4 + EJS — 서버 사이드 렌더링, 빌드 없음.
  • Postgres (pg) — OpenEverest appdb, schema portal.
  • Keycloak OIDC (openid-client v5) — Authorization Code.
  • 정적 CSS 한 장: public/style.css. 로고: public/logo.svg.

명령

  • npm run devnode --watch, http://localhost:3000
  • npm start — 프로덕션 (node index.js)
  • npm run db:initschema.sql 적용 (멱등, 최초 1회)
  • 로컬 환경변수 로드: cp .project-env.example .project-env 로 값을 채운 뒤 set -a; . ./.project-env; set +a

구조 맵

  • index.jssrc/server.js 진입 (Kubero buildpack run = node index.js)
  • src/server.js — Express 앱, 라우트, 부팅
  • src/config.js — 환경변수 설정
  • src/auth.js — Keycloak OIDC (로그인 리다이렉트 / 콜백 / requireAuth 가드)
  • src/db.js — Postgres 풀 + 쿼리 함수
  • src/sites.js — 대시보드 "사이트 바로가기" 카탈로그
  • views/_header, dashboard, login, project (EJS)
  • public/style.css, logo.svg
  • schema.sql — DB 스키마(멱등), scripts/init-db.js 가 적용
  • deploy/portal-route.yaml — Gateway HTTPRoute (portal.bokdev.in)
  • .claude/ — Claude Code 훅·설정

인증 모델

  • 사번 = Keycloak preferred_username. 세션에 req.session.user = { sabun, name, email }.
  • 미인증으로 보호 페이지 진입 시 중간 화면 없이 곧장 Keycloak 로그인으로 리다이렉트 (requireAuthloginRedirect). OIDC discovery 실패 시에만 login.ejs 폴백.
  • ⚠️ 알려진 문제: /logout 은 로컬 세션만 파기 → Keycloak SSO 세션이 남아 재진입 시 자동 재로그인된다(= 로그아웃 안 됨). 세션이 인메모리라 재시작/다중 replica 시 로그인이 풀린다. 자세한 내용과 해결 작업은 PLANS.md 참고.

배포

  • Kubero NodeJS buildpack (npm installnode index.js). 평소 Dockerfile 불필요.
  • Dockerfile 은 Kubero buildpack 의 harbor push 실패를 우회하는 수동 push 용.
  • 도메인 portal.bokdev.in (deploy/portal-route.yaml). 도메인 추가 시 Keycloak portal client redirect 에 https://<도메인>/auth/callback 등록 필요.
  • Kubero Env: BASE_URL, DATABASE_URL, OIDC_*, SESSION_SECRET, PORTAL_BRAND.

컨벤션

  • 라우트는 src/server.js 에, DB 접근은 src/db.js 의 함수로만 (인라인 SQL 산재 금지).
  • 새 화면을 추가할 때는 views/_header 를 include 하고 기존 .box / .btn / .tag 등 CSS 클래스를 재사용한다. 새 스타일은 public/style.css 한 곳에.
  • DB 스키마 변경은 schema.sql 에 멱등(IF NOT EXISTS)으로 추가하고 npm run db:init 재실행.
  • 브랜드명은 하드코딩하지 말고 PORTAL_BRAND(= res.locals.brand)를 사용한다.