Mina Choi 1856644972 문서: README 를 지금 구조로 맞춘다

- 주소표를 갈랐다. 내부 화면(:3002)·내부 API(:9801)가 127.0.0.1 에만 열린다는 걸 적었다.
- 클론 직후 `cp nginx/site.conf.example` 을 넣었다 — 빼먹으면 Docker 가 그 자리에
  디렉토리를 만들어 nginx 가 설정 없이 뜬다.
- npm 워크스페이스 루트가 레포 루트라는 것, 스키마가 init.sql 한 벌이라는 것.
- 레포 구조를 admin/{backend,frontend} 까지 반영.
- 문서 지도에 DEVELOPMENT_DIRECTION 이 두 줄 있었다. "한 사실은 한 곳에"를 이 표가
  스스로 어기고 있었다.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019uYhHQdssRubirPirrdJJC

2026-08-31 16:32:41 +09:00

4.5 KiB

Raw Blame History

o2o-web4ai

상호명 하나로 소상공인 홈페이지를 만들어 발행하는 서비스.

목표는 예쁜 사이트가 아니다 — AI 검색과 검색엔진이 이 가게를 "공식 홈페이지 기준"으로 설명하게 만드는 것이다. 그래서 산출물은 SPA 가 아니라 크롤러가 그대로 읽는 정적 HTML 이고, 발행 게이트가 통과시키지 않은 값은 사이트에 나가지 않는다.

무엇을 · 누구를 위해 · 무엇을 안 하는가 → docs/PRODUCT.md
어떻게 도는가 (파이프라인·앱 경계) → docs/ARCHITECTURE.md
에이전트·신규 합류자가 먼저 읽을 규약 → AGENTS.md

실행

cp .env.example .env                              # DB_*, JWT_*, 외부 API 키
cp nginx/site.conf.example nginx/site.conf        # 빼먹으면 nginx 가 설정 없이 뜬다
docker compose up -d
docker compose logs -f worker

	주소	공개
사장님 앱 (빌더)	http://localhost:3000	외부
발행된 사이트	http://localhost:3000/s/`<slug>` · 운영은 :80	외부
사장님 API 문서	http://localhost:9800/docs	외부
내부 운영 화면	http://localhost:3002	127.0.0.1 만
내부 API 문서	http://localhost:9801/docs	127.0.0.1 만

내부 두 개를 0.0.0.0 으로 열면 앱을 가른 의미가 없다 (ADMIN_BIND · ADMIN_API_BIND).

DB 는 compose 밖이다 (호스트 PostgreSQL, host.docker.internal). 스키마는 postgres-init/init-data/init.sql 한 벌 — 누적 ALTER 파일은 없다.
npm 워크스페이스 루트는 레포 루트다. npm install 은 여기서 한 번. npm run dev:frontend / dev:admin / dev:site
백엔드 스크립트는 solution/backend/ 에서 .venv/bin/python scripts/<name>.py
테스트는 solution/backend/ 에서 .venv/bin/pytest

레포 구조

solution/          사장님 — 사이트 만들기·관리
  backend/         FastAPI(:9800) + 워커. HTML 은 만들지 않는다 — payload JSON 만 떨어뜨린다
  frontend/        빌더 (위저드 + 에디터 + 발행 게이트)
  site/            발행 사이트. SSR 엔트리 + 프리렌더 + 정적 서버
  shared/          frontend·site·백엔드 계약 (SitePayload · slug · 디자인 토큰)
admin/             우리 — 전체 사이트 운영
  backend/         진입점만(:9801). 도메인 코드는 solution/backend 를 PYTHONPATH 로 쓴다
  frontend/        운영 화면. `@` 별칭이 solution/frontend/src 를 가리킨다
docs/              아래 표
nginx/             발행 사이트 정적 서빙 (site.conf 는 .example 만 커밋)
postgres-init/     스키마 DDL

의존 방향은 admin → solution 한 쪽뿐이다. 반대가 생기면 번들을 가른 의미가 사라진다. 근거는 ARCHITECTURE.md 4절.

문서 지도

문서	언제 읽나
docs/PRODUCT.md	이 제품이 뭘 푸는지 · 안 하기로 한 것이 뭔지
docs/ARCHITECTURE.md	발행 파이프라인 전체 · 두 앱과 한 백엔드의 경계
docs/DEVELOPMENT_DIRECTION.md	v19 설계서 대비 격차 · 개발 우선순위(P0~P4)
docs/DECISIONS.md	미결 사항과, 코드가 그걸 어떻게 격리해 뒀는지
docs/DEPLOY.md	서버에 올릴 때 · 배포 후 재발행 절차
docs/DATA_SOURCE_RESEARCH.md	어디서 콘텐츠를 가져올 수 있나 (실측 근거)
docs/COLLECTION_SEO_AEO_FLOW.md	수집→LLM→SEO/AEO 현재 구현
docs/API_USAGE.md	API 비용 — 제품 원가와 개발비 구분

문서 규칙

한 사실은 한 곳에. 중복된 문서는 썩고, 썩은 문서는 사람과 에이전트를 적극적으로 오도한다. 다른 문서의 내용은 복사하지 말고 링크한다.
코드가 말해주는 건 쓰지 않는다. 문서에 적을 값어치가 있는 건 왜 이렇게 했는지, 왜 저건 안 했는지, 그리고 실측값(날짜와 함께)이다.
결론이 나면 DECISIONS.md 에 날짜와 함께 적고, 격리해 둔 플래그를 제거한다.
문서는 코드와 같은 커밋·같은 리뷰에서 고친다. 동작을 바꾸는 PR 이 문서를 안 고쳤으면 미완이다.

4.5 KiB Raw Blame History

o2o-web4ai

실행

레포 구조

문서 지도

문서 규칙

4.5 KiB

Raw Blame History