ํ๋ก์ ํธ ๋ฌธ์ ๋ค๋น๊ฒ์ด์
์์คํ ๊ตฌ์กฐ ๋ฐ ๋ฐ์ดํฐ๋ฒ ์ด์ค ์ค๊ณ ๋ฌธ์์ ๋๋ค.
| ๋ฌธ์ | ์ค๋ช |
|---|---|
| ARCHITECTURE.md | ์์คํ ์ํคํ ์ฒ, ๋ ์ด์ด ๊ตฌ์กฐ, ๋์์ธ ํจํด |
| ERD.md | ๋ฐ์ดํฐ๋ฒ ์ด์ค ์ค๊ณ์, DDL, Enum ์ ์ |
| INFRASTRUCTURE.md | GCP ์ธํ๋ผ ๊ตฌ์ฑ, ํ๊ฒฝ๋ณ ์ค์ , ๋น์ฉ |
์ฝ๋ ์์ฑ ๋ฐ ํ์ ๊ท์น ๋ฌธ์์ ๋๋ค.
| ๋ฌธ์ | ์ค๋ช |
|---|---|
| CODE_STYLE.md | Java/Spring Boot ์ฝ๋ ์คํ์ผ ๊ฐ์ด๋ |
| CONVENTIONS.md | ๋ค์ด๋ฐ ์ปจ๋ฒค์ , Git ๋ธ๋์น/์ปค๋ฐ ๊ท์น, ๋ฆด๋ฆฌ์ค ํ๋ก์ธ์ค |
| API.md | API ๋ช ์ธ, ์๋ต ํ์, ์๋ฌ ์ฝ๋ |
๊ฐ๋ฐ ํ๊ฒฝ ์ค์ ๋ฐ ๊ธฐ๋ฅ๋ณ ๊ฐ์ด๋ ๋ฌธ์์ ๋๋ค.
| ๋ฌธ์ | ์ค๋ช |
|---|---|
| GCS_SETUP.md | Google Cloud Storage ์ค์ ๊ฐ์ด๋ |
| LOCAL_DEVELOPMENT.md | ๋ก์ปฌ ๊ฐ๋ฐ ํ๊ฒฝ ์ค์ (GCS Presigned URL ํ ์คํธ) |
| ENV_VARIABLES.md | ํ๊ฒฝ ๋ณ์ ๊ด๋ฆฌ ๊ฐ์ด๋ (๋ก์ปฌ ์ค์ , Secret Manager ์ ๊ทผ) |
| REMOTE_DB_ACCESS.md | Cloud SQL ์๊ฒฉ ์ ์ ๊ฐ์ด๋ (IAP ํฐ๋) |
| AUTHENTICATION_PRINCIPAL.md | ์ปค์คํ ์ธ์ฆ ๊ฐ์ฒด (AuthUser) ์ฌ์ฉ๋ฒ |
์ธํ๋ผ ์ด์ ๋ฌธ์์ ๋๋ค. ์์ธ ์ธ๋ฑ์ค๋ infra/README.md๋ฅผ ์ฐธ๊ณ ํ์ธ์.
| ๋ฌธ์ | ์ค๋ช | ๋์ |
|---|---|---|
| SECRET_MANAGEMENT.md | GCP Secret Manager ๊ด๋ฆฌ ๊ฐ์ด๋ | ๋ชจ๋ ๊ฐ๋ฐ์ |
| GCP_LOGGING_GUIDE.md | GCP Cloud Logging ํ์ธ ๊ฐ์ด๋ | DevOps |
| IAC_TERRAFORM_INTRO.md | IaC/Terraform ๊ฐ๋ ํ์ต | ๋ชจ๋ ๊ฐ๋ฐ์ |
| TERRAFORM_OPERATIONS.md | Terraform ์ด์ ๊ฐ์ด๋ | DevOps |
| GCP_PROJECT_MIGRATION_RUNBOOK.md | GCP ํ๋ก์ ํธ ๋ง์ด๊ทธ๋ ์ด์ ๋ฐ๋ถ | DevOps |
- CONTRIBUTING.md - ๊ธฐ์ฌ ๊ฐ์ด๋
- SECURITY.md - ๋ณด์ ์ ์ฑ
๋ง์ง๋ง ์ ๋ฐ์ดํธ: 2026-02-11