From 38502b239186d21ed400d0018b7ded8173cc7672 Mon Sep 17 00:00:00 2001 From: Mo Kweon Date: Sun, 3 Oct 2021 11:43:08 -0700 Subject: [PATCH 1/2] feat: update README.md --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index f6d9c6b2..b32c0afc 100644 --- a/README.md +++ b/README.md @@ -27,3 +27,30 @@ make install ```shell make gen.all ``` + +## 구조 설명 + +``` +. +├── buf.gen.yaml # Buf 관련 파일 +├── buf.yaml # Buf 관련 파일 +├── client # 프론트 코드 (Flutter) +├── codecov.yml # 코드 커버리지 CI 설정 파일 +├── dbctl # 데이터베이스 파일을 업데이트하기 위한 CLI +├── hooks # GitHub Hooks 설치 파일 +├── k8s # 쿠버네티스 yaml 파일 +├── LICENSE +├── Makefile # 메인 빌드툴 +├── okteto-pipeline.yaml # production 배포 파이프라인 +├── pr12er_diagram.drawio # 이 파일의 맨 위 그림을 담당 +├── pr12er_diagram.svg +├── README.md +├── server # 실제 백엔드 서버 (Go) +├── skaffold.yaml # 개발용 skaffold 스펙 +├── thirdparty # Protocol Buffer Timestamp proto dependency +└── tools # 빌드툴 관련 Dockerfile +``` + +## Design Docs + +- [PR12er 데이터 디자인](https://docs.google.com/document/d/1UE-v0mYirRdBI1kaK00mG2SPqAuYv9b2WLjEXWGDwnU/edit?usp=sharing) From 425855aef2c5a5a622d2b5e0a42be32c013ed22e Mon Sep 17 00:00:00 2001 From: Mo Kweon Date: Sun, 3 Oct 2021 11:44:59 -0700 Subject: [PATCH 2/2] fix: differentiate directories --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b32c0afc..618c5874 100644 --- a/README.md +++ b/README.md @@ -34,21 +34,21 @@ make gen.all . ├── buf.gen.yaml # Buf 관련 파일 ├── buf.yaml # Buf 관련 파일 -├── client # 프론트 코드 (Flutter) +├── client/ # 프론트 코드 (Flutter) ├── codecov.yml # 코드 커버리지 CI 설정 파일 -├── dbctl # 데이터베이스 파일을 업데이트하기 위한 CLI -├── hooks # GitHub Hooks 설치 파일 -├── k8s # 쿠버네티스 yaml 파일 +├── dbctl/ # 데이터베이스 파일을 업데이트하기 위한 CLI +├── hooks/ # GitHub Hooks 설치 파일 +├── k8s/ # 쿠버네티스 yaml 파일 ├── LICENSE ├── Makefile # 메인 빌드툴 ├── okteto-pipeline.yaml # production 배포 파이프라인 ├── pr12er_diagram.drawio # 이 파일의 맨 위 그림을 담당 ├── pr12er_diagram.svg ├── README.md -├── server # 실제 백엔드 서버 (Go) +├── server/ # 실제 백엔드 서버 (Go) ├── skaffold.yaml # 개발용 skaffold 스펙 -├── thirdparty # Protocol Buffer Timestamp proto dependency -└── tools # 빌드툴 관련 Dockerfile +├── thirdparty/ # Protocol Buffer Timestamp proto dependency +└── tools/ # 빌드툴 관련 Dockerfile ``` ## Design Docs