Mina Choi
fc47946d3f
세팅할 때마다 "이 값이 어디 가는 거지" 를 코드에서 되짚고 있었다. AGENTS.md 에 설정 파일 지도를 넣고, 흩어져 있던 cp 명령을 거기 한 곳으로 모았다. 두는 곳 — 템플릿이 전부 짝을 갖는다(7개 확인). 루트 .env ← 백엔드가 읽는 유일한 .env solution/backend/config/ config.local.toml DB·JWT·포트·CORS solution/backend/config/ config.test.toml 없으면 pytest 가 import 단계에서 죽는다 solution/frontend/ .env VITE_* (API :9800) admin/frontend/ .env VITE_* (API :9801) nginx/ site.conf 없으면 Docker 가 디렉토리를 만든다 두지 않는 곳과 그 이유도 같이 적었다 — solution/backend(dotenv 가 루트를 본다), admin/backend(PYTHONPATH 로 solution 것을 쓴다), solution/site, solution/shared. solution/site/.env.example 을 지웠다. "여기엔 아무것도 없다" 는 걸 알리려고 둔 파일인데, .env.example 은 이 레포에서 "복사해서 채워라" 라는 뜻이라 정반대 신호를 준다. 그 설명은 지도의 '두지 않는 곳' 으로 옮겼다. 그 밖에 - config.test.toml.example 의 server_name 이 O2oSiteServerTest 로 남아 있었다. - config.local.toml.example 에 생략 가능한 [ExternalApiConfig] 필드 셋을 주석으로 적었다. - .gitignore 의 *.toml 이 레포 전체를 덮는다는 것과, 그래서 pyproject.toml 같은 걸 추가하면 조용히 무시된다는 것을 규칙 옆에 적었다.
82 lines
4.6 KiB
Markdown
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회 — 설정 파일 복사 목록은 AGENTS.md "설정 파일은 어느 폴더에 두나"
|
|
cp .env.example .env
|
|
cp nginx/site.conf.example nginx/site.conf
|
|
cp solution/backend/config/config.local.toml.example solution/backend/config/config.local.toml
|
|
|
|
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 이 문서를 안 고쳤으면 미완이다.
|