Merge pull request #31 from f-lab-edu/docs/#30/readme

docs: add current project infos
f-lab-edu · Nov 10, 2022 · b08fc44 · b08fc44
2 parents 59a9310 + c253284
commit b08fc44
Show file tree

Hide file tree

Showing 14 changed files with 4,780 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -1,25 +1,41 @@
 # Air Mart
 
 ## 사용 기술 스택
+- Java 11+
 - Spring Boot
 - Spring Cloud
 - Spring Security
+- Spring Batch 
+- JPA
 - Docker
+- Docker Compose
 - MySQL
 - Redis
-...
+- Kafka
 
-## 서비스 소개
-공동 구매 마켓입니다.
+## Air Mart 서비스 소개
+간단하지만 강력한 공동 구매 마켓입니다. 판매자는 목표하는 묶음 개수의 상품을 등록하면, 소비자는 묶음 개수 단위로 구매할 수 있습니다. 
+묶음 개수를 혼자 감당하기 힘들다면 즉석으로 다른 사람과 공동 구매를 할 팀을 구성할 수 있습니다.
 
-## Workflow
+## [Workflow](./workflow/README.md)
+![total](./images/total_workflow.png)
 
 ## ERD
 
-## Service Architecture
+## Software Architecture
+![real_arch](./images/real_architecture_221110.png)
 
-## API Gateway
+## Service Concept Architecture
+![concept_arch](./images/concept_architecture.png)
 
-## Convention
+## Micro Service Info
+|Micro Service Name|URI(Prefix)|Local Webserver Port|Occupied Port|
+|:---|:---|:---|:---|
+|Order Command Service|`/orders/**`, Http Method - `POST`,`PUT`,`DELETE` |9100|MySQL:3307|
+|Order Query Service|`/orders/**`, Http Method - `GET`|9100|MySQL:3307|
+|Item Service|`/items/**`|8081|MySQL:3306, MongoDB:27017|
+|Joo Notification Service|`/jooi/noti/**`|8082|MySQL:3308|
+
+## [Convention](./docs/convention.md)
 
 ## Issue & Solution
diff --git a/docs/convention.md b/docs/convention.md
@@ -0,0 +1,52 @@
+### Code
+- [Google Java Style Guide Docs](https://google.github.io/styleguide/javaguide.html)
+- [Google style guide for Intellij](https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml)
+### Branch
+```
+main
+develop
+feature/{issue #}/{module}
+```
+
+### Commit
+```yaml
+feat: [구현 내용] #이슈번호
+chore: [빌드 내용 수정, 패키지 디펜던시 등 버전 관리 내용] #이슈번호
+docs: [문서 수정] #이슈번호
+refactor: [코드 리팩토링] #이슈번호
+test: [테스트 코드 추가, 수정] #이슈번호
+bugfix: [버그 수정] #이슈번호
+```
+
+### Project Package Structure
+```yaml
+common:
+  log: # log4j2, async 설정 잊지않기..
+  exception:
+  validation:
+    - validator
+    - validationPolicy interface
+    - validation policy implementation
+  util: #( ex. parser, static functions )
+config:
+    - security
+infrastructure: # ( ex. MessageSender )
+domainName1: # ( ex. Order )
+  controller:
+  service:
+    - facade
+    - query # 파일을 나누고 싶어질때 나눌 수 있다
+    - command
+  repository:
+  dto:
+  business exception:
+  domain: #( ex Campaign, .... 등 묶일 수 있는 Entity, VO 객체)
+    - entity
+domainName2:
+  controller:
+  service:
+  repository:
+  dto:
+  business exception:
+  domain:
+```
diff --git a/images/concept_architecture.png b/images/concept_architecture.png
diff --git a/images/item_command_workflow.png b/images/item_command_workflow.png
diff --git a/images/item_query_workflow.png b/images/item_query_workflow.png
diff --git a/images/noti_command_workflow.png b/images/noti_command_workflow.png
diff --git a/images/noti_query_workflow.png b/images/noti_query_workflow.png
diff --git a/images/order_command_workflow.png b/images/order_command_workflow.png
diff --git a/images/order_query_workflow.png b/images/order_query_workflow.png
diff --git a/images/real_architecture_221110.png b/images/real_architecture_221110.png
diff --git a/images/total_workflow.png b/images/total_workflow.png
diff --git a/images/user_workflow.png b/images/user_workflow.png