o2o-site-AEO/README.md
Mina Choi 6bfd48d3c4 문서: 설정 파일이 6개 필요한 것처럼 적혀 있던 것을 바로잡는다
앞 커밋의 표가 여섯 줄을 나란히 놓아서 "클론하면 여섯 개를 만들어야 한다" 로 읽혔다.
실제로 세어 보니 compose 로 띄우는 데 필요한 건 둘이다.

- .env            compose 가 env_file 로 읽는다
- nginx/site.conf compose 가 bind mount 한다

나머지 넷은 필수가 아니다.
- config.local.toml : 도커 이미지가 example 사본을 구워서 나온다(Dockerfile:24).
  호스트에서 python web_main.py 를 직접 돌릴 때만 손으로 만든다.
- config.test.toml  : pytest 를 돌릴 때만.
- 프론트 .env 둘    : VITE_* 가 전부 코드 폴백을 갖고 있고(?? 'http://localhost:9800',
  ?? window.location.host) compose 는 값을 직접 주입한다. 만들 이유가 없다.

표를 필수/선택/안 만들어도 됨으로 갈랐다. 클론 직후 명령도 둘로 줄이고,
toml 은 "호스트에서 돌릴 때만" 이라는 조건을 붙여 아래로 내렸다.
2026-08-31 17:15:47 +09:00

82 lines
4.6 KiB
Markdown

# o2o-web4ai
**상호명 하나로 소상공인 홈페이지를 만들어 발행하는 서비스.**
목표는 예쁜 사이트가 아니다 — **AI 검색과 검색엔진이 이 가게를 "공식 홈페이지 기준"으로
설명하게 만드는 것**이다. 그래서 산출물은 SPA 가 아니라 **크롤러가 그대로 읽는 정적 HTML** 이고,
발행 게이트가 통과시키지 않은 값은 사이트에 나가지 않는다.
- 무엇을 · 누구를 위해 · 무엇을 안 하는가 → **[docs/PRODUCT.md](docs/PRODUCT.md)**
- 어떻게 도는가 (파이프라인·앱 경계) → **[docs/ARCHITECTURE.md](docs/ARCHITECTURE.md)**
- 에이전트·신규 합류자가 먼저 읽을 규약 → **[AGENTS.md](AGENTS.md)**
## 실행
```bash
# 클론 직후 1회 — compose 에 필요한 건 이 둘뿐이다.
# 호스트에서 백엔드·pytest 를 직접 돌릴 때 붙는 toml 은 AGENTS.md 참고.
cp .env.example .env # JWT_* 를 채운다
cp nginx/site.conf.example nginx/site.conf
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/ARCHITECTURE.md).
## 문서 지도
| 문서 | 언제 읽나 |
|---|---|
| [docs/PRODUCT.md](docs/PRODUCT.md) | 이 제품이 뭘 푸는지 · **안 하기로 한 것**이 뭔지 |
| [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) | 발행 파이프라인 전체 · 두 앱과 한 백엔드의 경계 |
| [docs/DEVELOPMENT_DIRECTION.md](docs/DEVELOPMENT_DIRECTION.md) | v19 설계서 대비 격차 · **개발 우선순위(P0~P4)** |
| [docs/DECISIONS.md](docs/DECISIONS.md) | 미결 사항과, 코드가 그걸 어떻게 격리해 뒀는지 |
| [docs/DEPLOY.md](docs/DEPLOY.md) | 서버에 올릴 때 · 배포 후 재발행 절차 |
| [docs/DATA_SOURCE_RESEARCH.md](docs/DATA_SOURCE_RESEARCH.md) | 어디서 콘텐츠를 가져올 수 있나 (실측 근거) |
| [docs/COLLECTION_SEO_AEO_FLOW.md](docs/COLLECTION_SEO_AEO_FLOW.md) | 수집→LLM→SEO/AEO 현재 구현 |
| [docs/API_USAGE.md](docs/API_USAGE.md) | 외부 API 원가 — 사이트 1건당 $1 상한을 어디서 강제하나 |
## 문서 규칙
1. **한 사실은 한 곳에.** 중복된 문서는 썩고, 썩은 문서는 사람과 에이전트를 적극적으로 오도한다.
다른 문서의 내용은 복사하지 말고 링크한다.
2. **코드가 말해주는 건 쓰지 않는다.** 문서에 적을 값어치가 있는 건 *왜 이렇게 했는지*,
*왜 저건 안 했는지*, 그리고 **실측값**(날짜와 함께)이다.
3. **결론이 나면 `DECISIONS.md` 에 날짜와 함께 적고, 격리해 둔 플래그를 제거한다.**
4. 문서는 코드와 같은 커밋·같은 리뷰에서 고친다. 동작을 바꾸는 PR 이 문서를 안 고쳤으면 미완이다.