From f679ce1656e9fbb953e065b0804409907d9edb16 Mon Sep 17 00:00:00 2001 From: Kwoun Ki Ho Date: Mon, 28 Aug 2023 13:12:34 +0900 Subject: [PATCH 1/5] =?UTF-8?q?docs:=20README=20=EC=97=85=EB=8D=B0?= =?UTF-8?q?=EC=9D=B4=ED=8A=B8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 59 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3bdfb627..4db2daa5 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ 프로젝트 겟차를 진행하게 된 H1 팀 마이카 딥 다이브(MyCar Deep Dive) 입니다 🙂
내 차 만들기 개선에 깊게 몰두하겠습니다 🌊 +
@@ -40,9 +41,10 @@
-## GitHub Convention +## 배포 +Web: https://make-my-car.shop -### 브랜치 구조 +## 브랜치 구조 
 main
@@ -56,6 +58,61 @@ ios-main
 ios-dev
   ios/feature/기능
+--- + +### BE Main 브랜치 +https://github.com/softeerbootcamp-2nd/H1-MyCarDeepDive/tree/be-main +### iOS Main 브랜치 +https://github.com/softeerbootcamp-2nd/H1-MyCarDeepDive/tree/fe-main +### iOS Main 브랜치 +https://github.com/softeerbootcamp-2nd/H1-MyCarDeepDive/tree/ios-main +## ERD + +![](https://github.com/softeerbootcamp-2nd/H1-MyCarDeepDive/assets/73146678/785bec39-f8bf-49db-8bd0-976db353408d) + +## API Specs + +https://api.make-my-car.shop/docs/swagger + +## Tech Spec + +[Backend] +- Java 11 +- Spring Boot 2.7.1 +- Spring Data JPA +- Querydsl +- SwaggerUI/RestDocs + +[Database] +- MySQL 8.0.34 +- H2 Database +- Flyway + +[Testing] +- Jacoco +- MockMVC + +[DevOps] +- Github Action +- Docker +- Spotless +- AWS EC2 (Ubuntu 18.04) +- AWS S3 +- AWS CloudFront + +[Logging] +- Actuator +- Grafana +- Prometheus +- Filebeat +- Logstash +- ElasticSearch +- Kibana + +[ETC] +- AWS Parameter Store + + ### Commit Convention From d76a3ab1c9928b9671462ef8b51a68d87dedf9c9 Mon Sep 17 00:00:00 2001 From: Kwoun Ki Ho Date: Mon, 28 Aug 2023 15:56:22 +0900 Subject: [PATCH 2/5] =?UTF-8?q?docs:=20=EB=B0=B1=EC=97=94=EB=93=9C=20ci/cd?= =?UTF-8?q?,=20=EC=95=84=ED=82=A4=ED=85=8D=EC=B2=98=20=EC=9D=B4=EB=AF=B8?= =?UTF-8?q?=EC=A7=80=20=EC=97=85=EB=A1=9C=EB=93=9C?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4db2daa5..74895ebb 100644 --- a/README.md +++ b/README.md @@ -66,8 +66,15 @@ https://github.com/softeerbootcamp-2nd/H1-MyCarDeepDive/tree/be-main https://github.com/softeerbootcamp-2nd/H1-MyCarDeepDive/tree/fe-main ### iOS Main 브랜치 https://github.com/softeerbootcamp-2nd/H1-MyCarDeepDive/tree/ios-main -## ERD + +## Architecture +![](https://github.com/softeerbootcamp-2nd/H1-MyCarDeepDive/assets/73146678/11d66869-aed1-4478-9ab9-e439e7705722) + +## CI/CD +![](https://github.com/softeerbootcamp-2nd/H1-MyCarDeepDive/assets/73146678/8c90869a-87fe-4f50-a794-6344b872ef09) + +## ERD ![](https://github.com/softeerbootcamp-2nd/H1-MyCarDeepDive/assets/73146678/785bec39-f8bf-49db-8bd0-976db353408d) ## API Specs From dd2f8f51856a264335164e453ab056b5016c1c28 Mon Sep 17 00:00:00 2001 From: Sunki <96693975+ajsthfldu@users.noreply.github.com> Date: Mon, 28 Aug 2023 16:05:00 +0900 Subject: [PATCH 3/5] Update README.md --- README.md | 39 --------------------------------------- 1 file changed, 39 deletions(-) diff --git a/README.md b/README.md index 74895ebb..9571f24a 100644 --- a/README.md +++ b/README.md @@ -81,45 +81,6 @@ https://github.com/softeerbootcamp-2nd/H1-MyCarDeepDive/tree/ios-main https://api.make-my-car.shop/docs/swagger -## Tech Spec - -[Backend] -- Java 11 -- Spring Boot 2.7.1 -- Spring Data JPA -- Querydsl -- SwaggerUI/RestDocs - -[Database] -- MySQL 8.0.34 -- H2 Database -- Flyway - -[Testing] -- Jacoco -- MockMVC - -[DevOps] -- Github Action -- Docker -- Spotless -- AWS EC2 (Ubuntu 18.04) -- AWS S3 -- AWS CloudFront - -[Logging] -- Actuator -- Grafana -- Prometheus -- Filebeat -- Logstash -- ElasticSearch -- Kibana - -[ETC] -- AWS Parameter Store - - ### Commit Convention From 7d7d813ec90793d4192f613db29510a41a63dbd2 Mon Sep 17 00:00:00 2001 From: choiseona <52223965+choiseona@users.noreply.github.com> Date: Mon, 28 Aug 2023 16:27:59 +0900 Subject: [PATCH 4/5] Update README.md --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 9571f24a..a2126c62 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,31 @@
+## 🛠 기술 스택 + +### 🌐 Frontend +|역할|종류| +|-|-| +|Library|RED +|Language| +|Styling|| +|Formatting|![ESLint](https://img.shields.io/badge/ESLint-4B3263?style=for-the-badge&logo=eslint&logoColor=white) ![Prettier](https://img.shields.io/badge/Prettier-F7B93E?style=for-the-badge&logo=prettier&logoColor=white)| +|Package Manager|| +|Version Control|![Git](https://img.shields.io/badge/git-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white) ![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white) | +|CI/CD|![GihubAction](https://img.shields.io/badge/githubactions-2088FF?style=for-the-badge&logo={githubactions}&logoColor={white}) RED | +
+ +### 🖥 Backend + +### 🖥 Common +|역할|종류| +|-|-| +|협업 관리|RED +|디자인|RED| +|API| + +
+ ## 배포 Web: https://make-my-car.shop From 4ecb50690ba5031394200bb8bae7dd61fd5b9a07 Mon Sep 17 00:00:00 2001 From: choiseona <52223965+choiseona@users.noreply.github.com> Date: Mon, 28 Aug 2023 16:33:05 +0900 Subject: [PATCH 5/5] =?UTF-8?q?docs:=20=EB=A6=AC=EB=93=9C=EB=AF=B8=20?= =?UTF-8?q?=EC=9E=91=EC=84=B1?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a2126c62..9adfb338 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,10 @@
+## 배포 +🚙 [MyCarDeepDive WEB](https://make-my-car.shop) +
+ ## 🛠 기술 스택 ### 🌐 Frontend @@ -55,7 +59,9 @@ |CI/CD|![GihubAction](https://img.shields.io/badge/githubactions-2088FF?style=for-the-badge&logo={githubactions}&logoColor={white}) RED |
-### 🖥 Backend +### 🌸 Backend + +###  IOS ### 🖥 Common |역할|종류| @@ -65,10 +71,6 @@ |API|
- -## 배포 -Web: https://make-my-car.shop - ## 브랜치 구조 
@@ -87,7 +89,7 @@ ios-dev
 
 ### BE Main 브랜치
 https://github.com/softeerbootcamp-2nd/H1-MyCarDeepDive/tree/be-main
-### iOS Main 브랜치
+### FE Main 브랜치
 https://github.com/softeerbootcamp-2nd/H1-MyCarDeepDive/tree/fe-main
 ### iOS Main 브랜치
 https://github.com/softeerbootcamp-2nd/H1-MyCarDeepDive/tree/ios-main
@@ -151,6 +153,6 @@ https://api.make-my-car.shop/docs/swagger
 
 ## 기획/디자인
 
-📝 [기획서 보기](https://www.figma.com/file/p1UkFMMha9P4UvMSgxjjUJ/Handoff_guidelines?node-id=1%3A6&mode=dev)
+📝 [기획서 보기](https://www.figma.com/file/p1UkFMMha9P4UvMSgxjjUJ/Handoff_guidelines?node-id=8%3A17111&mode=dev)
 
-🌈 [디자인 보기](https://www.figma.com/file/p1UkFMMha9P4UvMSgxjjUJ/Handoff_guidelines?node-id=8%3A17111&mode=dev)
+🌈 [디자인 보기](https://www.figma.com/file/p1UkFMMha9P4UvMSgxjjUJ/Handoff_guidelines?node-id=1%3A6&mode=dev)