[ALL] README 업데이트

Jinwook94 · Nov 1, 2023 · f4fb2bb · f4fb2bb
1 parent 0bacade
commit f4fb2bb
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 53 deletions.
diff --git a/README.md b/README.md
@@ -2,81 +2,70 @@
 [![backend deployment](https://github.com/Jinwook94/bootme/actions/workflows/backend-deploy.yml/badge.svg)](https://github.com/Jinwook94/bootme/actions/workflows/backend-deploy.yml)
 
 ## 프로젝트 소개
-- 소프트웨어 커리큘럼 등 개발자 취업 관련 정보 제공 서비스
+- 개발자 커뮤니티 & 소프트웨어 커리큘럼 Aggregator 웹 서비스
 
 <br>
 
-## 기술 스택
-- **TypeScript, React**, Webpack, Styled-components, React Query 
-- **Java11, Spring Boot, Spring Data JPA**, Spring REST Docs, Logback, Mockito, Mockmvc, JUnit5
-- AWS CodeDeploy, CloudWatch, EC2 (ALB, Auto Scaling), S3, RDS(Aurora), Secrets Manager
+## 결과물 URL
+| 결과물                | URL                                                                                                                                              |
+|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
+| 프로젝트 소개 문서         | [bootme.pdf](https://github.com/Jinwook94/bootme/files/13223261/bootme.pdf)                                                                      |
+| 개발 문서              | [samata94.notion.site/a26611d37ab2404d92366e4c5677efff?v](https://samata94.notion.site/a26611d37ab2404d92366e4c5677efff?v)                       |
+| 서비스 (운영)           | [bootme.co.kr](https://bootme.co.kr)                                                                                                             |
+| 서비스 (스테이징)         | [staging.bootme.co.kr](https://staging.bootme.co.kr)                                                                                             |
+| API 문서 (Swagger)   | [api.bootme.co.kr/docs/swagger/index.html](https://api.bootme.co.kr/docs/swagger/index.html)                                                     |
+| API 문서 (Rest Docs) | [api.bootme.co.kr/docs/rest/index.html](https://api.bootme.co.kr/docs/rest/index.html)                                                           |
+| ERD                | [dbdiagram.io/d/BootMe_ALL-64788f24722eb77494373f88](https://dbdiagram.io/d/BootMe_ALL-64788f24722eb77494373f88)                                 |
+| 디자인                | [figma.com/file/aTIdPnGfBe2ValxUY7zbFD/BootMe-Figma?node-id=360-2](https://www.figma.com/file/aTIdPnGfBe2ValxUY7zbFD/BootMe-Figma?node-id=360-2) |
 
 <br>
 
-## 인프라
-### HTTP 요청 처리 과정
-<img src="https://github.com/Jinwook94/bootme/assets/44575214/3a080bea-3e11-4b79-b883-bef65aa48c31">
-
-### Frontend CI/CD
-<img src="https://github.com/Jinwook94/bootme/assets/44575214/6351b7f7-6ff3-49de-b006-aaf07224932e">
+## 기술 스택
+- Java 17, TypeScript 4.8.4
+- Spring Boot 3.1.4, React 18.2.0, MariaDB 10.5.20
+- AWS CodeDeploy, CloudFront, EC2, S3, Secrets Manager
 
-### Backend CI/CD
-<img src="https://github.com/Jinwook94/bootme/assets/44575214/b5bea313-1cf5-4bb8-b059-0a0cfd4cb28a">
+<br>
 
-### CloudWatch 모니터링
+## 환경 구성
 
-```mermaid
-flowchart LR
+<details>
+  <summary>운영 환경</summary>
 
-subgraph EC2
-    subgraph Springboot
-        1[Tomcat]
-				2[ApplicationLogic]
-    end
-		subgraph Logs
-			3
-			4
-			5
-			6
-		end
-end
+  <img src="https://github.com/Jinwook94/bootme/assets/44575214/3bade8d0-6b3c-430e-8a53-f31485c2f6a4">
+</details>
 
-1 --logback--> 3[accessLog-text.log]
-1 --logback--> 4[accessLog-json.log]
-2 --logback--> 5[generalLog-text.log]
-2 --logback--> 6[generalLog-json.log]
+<details>
+  <summary>스테이징 환경</summary>
 
-subgraph CloudWatch
-	7[ Log Groups<br>ㅡㅡㅡㅡㅡㅡㅡㅡㅡ<br> springboot/access/text <br> springboot/access/json <br> springboot/general/text <br> springboot/general/json <br>]
-end
+  <img src="https://github.com/Jinwook94/bootme/assets/44575214/16178a70-34e0-4647-976e-ffbeba3da62f">
+</details>
 
-Logs --CloudWatch Agent--> CloudWatch
+<details>
+  <summary>로컬 개발 환경</summary>
 
-Springboot:::springboot
-CloudWatch:::cloudwatch
-classDef springboot fill:#a7f49a,stroke:#FFF
-classDef cloudwatch fill:#f2d5e0, stroke:#FFF
-```
+  <img src="https://github.com/Jinwook94/bootme/assets/44575214/f0c16ceb-450a-46aa-845a-765e119c595c">
+</details>
 
 <br>
 
-## 주요 요청 처리 흐름
-
+## 배포 자동화
 <details>
-  <summary>로그인 요청</summary>
-  <img width="800" alt="image" src="https://github.com/Jinwook94/bootme/assets/44575214/23e2cf53-9460-4b2c-8010-705c602b3205">
+  <summary>프론트엔드</summary>
+
+  <img src="https://github.com/Jinwook94/bootme/assets/44575214/61817685-222f-4bf8-a10d-9cffaf13d994">
 </details>
+
 <details>
-    <summary>엑세스 토큰 검증 및 재발급</summary>
-    <img alt="image" src="https://github.com/Jinwook94/bootme/assets/44575214/72d225b2-b1b9-4ecc-a69f-085dee4237a8">
-    <img width="350" alt="image" src="https://github.com/Jinwook94/bootme/assets/44575214/a847dfd5-1afe-4b13-b66f-502b9b251be2">
+  <summary>백엔드</summary>
+
+  <img src="https://github.com/Jinwook94/bootme/assets/44575214/2569b04f-74e8-457a-815e-5d641afce6c1">
 </details>
 
 <br>
 
-## API 문서
-
-- https://api.bootme.co.kr/docs/swagger/index.html
-- https://api.bootme.co.kr/docs/rest/index.html
+## 주요 기능
+<img src="https://github.com/Jinwook94/bootme/assets/44575214/a7c8fad7-2db3-44fa-8f08-cf8c28b4bc80">
+<img src="https://github.com/Jinwook94/bootme/assets/44575214/b4f85fed-a6f9-4ae2-9c9f-60486b8f4820">
 
 <br>
diff --git a/frontend/package-lock.json b/frontend/package-lock.json
diff --git a/frontend/package.json b/frontend/package.json
@@ -85,6 +85,7 @@
     "source-map-loader": "^4.0.1",
     "style-loader": "^3.3.1",
     "ts-loader": "^9.3.1",
+    "typescript": "^4.8.4",
     "webpack": "^5.74.0",
     "webpack-cli": "^4.10.0",
     "webpack-dev-server": "^4.11.0",