Merge pull request #49 from Q-CARD/feature/readme-update

Update README.md

README.md

@@ -1 +1,140 @@
-# QCard-server
+# 🧑‍💻 QCARD - "슬로건"
+
+[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https://https://github.com/Q-CARD/QCard-server&count_bg=%23FF7B72&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://hits.seeyoufarm.com)
+
+## 🥳 백엔드 팀원 소개
+
+<table border="1" cellspacing="0" cellpadding="0" width="90%">
+    <tr width="100%">
+        <td width="30%" align="center"><a href= "https://github.com/siyeonkm">김시연</a></td>
+        <td width="30%" align="center"><a href= "https://github.com/sunnyineverywhere">이선의</a></td>
+    </tr>
+    <tr width="100%">
+        <td width="30%" align="center"><img src = "https://github.com/siyeonkm.png" width="80%"/></td>
+        <td width="30%" align="center"><img src = "https://github.com/sunnyineverywhere.png" width="80%"/></td>
+    </tr>
+    <tr width="100%">
+       <td width="30%" align="center">[채팅] Websocket과 Stomp를 이용한 1:1 및 n:n 채팅 기능, 채팅방 관련 CRUD 기능  
+          </br> [프로필/워크스페이스] 프로필 및 워크스페이스 리팩토링 및 오류해결 진행
+          </br> [기타] mongodb 설계, api문서 작성, 리드미 작성 등.</td>
+        <td width="30%" align="center">[로그인] Google API를 이용한 Oauth2 로그인/회원가입, JWT와 Redis를 이용한 인가작업 관리 등 
+          </br> [유저] 유저 관련 CRUD
+          </br> [배포] Travis ci 및 Github Action을 이용한 CICD 파이프라인 구축
+          </br> [기타] mongodb 설계, api 문서 작성 등 </td>
+   </tr>
+</table>
+<br>
+
+## 👋 서비스 소개
+```**QCARD**는 소개소개```
+
+<br>
+
+## ⚙️ 기술 스택    
+- DEVELOP &nbsp; 
+![Spring](https://img.shields.io/badge/Spring-6DB33F?style=round-square&logo=Spring&logoColor=white) <img src="https://img.shields.io/badge/MongoDB-47A248?style=flat-square&logo=MongoDB&logoColor=white"/> <img src="https://img.shields.io/badge/Google-4285F4?style=flat-square&logo=Google&logoColor=white"/> <img src="https://img.shields.io/badge/Stomp-010101?style=flat-square&logo=Stomp&logoColor=white"/> <img src="https://img.shields.io/badge/Websocket-010101?style=flat-square&logo=Websocket&logoColor=white"/> <img src="https://img.shields.io/badge/Redis-DC382D?style=flat-square&logo=Redis&logoColor=white"/>
+
+- INFRA &nbsp;
+<img src="https://img.shields.io/badge/Amazon CodeDeploy-7D9B4B?style=flat-square&logo=Amazon CodeDeploy&logoColor=white"/> <img src="https://img.shields.io/badge/Travis CI-3EAAAF?style=flat-square&logo=Travis CI&logoColor=white"/>
+
+
+- ETC &nbsp; 
+<img src="https://img.shields.io/badge/GitHub -181717?style=flat-square&logo=GitHub&logoColor=white"/> <img src="https://img.shields.io/badge/GitHub Actions-256EE0?style=flat-square&logo=GitHub Actions&logoColor=white"/></br>
+
+<br>
+
+## 🗂️ 프로젝트 구조
+
+### ERD
+
+### 라이브러리
+1. spring boot web
+2. spring boot mongodb
+3. spring boot mail
+4. spring boot thymeleaf
+5. spring boot security
+6. spring boot data redis
+7. spring boot websocket
+8. spring boot test
+9. lombok
+10. sockjs-client
+11. stomp-websocket
+12. gson
+13. jjwt
+
+### 폴더 
+<pre>
+<code>
+└── 🗂 main
+    ├── 🗂 java
+    │   └── 🗂 web
+    │       └── 🗂 slack
+    │           ├── 📑 SlackCloneProjectApplication.java
+    │           ├── 🗂 config
+    │           │   ├── 🗂 annotation
+    │           │   │   └── 📑 AuthMember.java
+    │           │   ├── 🗂 handlers
+    │           │   │   └── 📑 ChatPreHandler.java
+    │           │   │   └── 📑 CustomLoginSuccessHandler.java
+    │           │   │   └── 📑 CustomLogoutSucessHandler.java
+    │           │   ├── 🗂 jwt
+    │           │   │   └── 📑 JwtAuthenticationFilter.java
+    │           │   │   └── 📑 JwtTokenProvider.java
+    │           │   ├── 📑 AuthMemberArgumentResolver.java
+    │           │   ├── 📑 CorsConfig.java
+    │           │   ├── 📑 WebConfig.java
+    │           │   ├── 📑 WebSocketConfig.java
+    │           │   └── 📑 SecurityConfig.java
+    │           ├── 🗂 controller
+    │           │   ├── 🗂 dto - 생략
+    │           │   ├── 📑 ChatroomController.java
+    │           │   ├── 📑 ChatTestController.java
+    │           │   ├── 📑 EmailController.java
+    │           │   ├── 📑 MemberController.java
+    │           │   ├── 📑 MessageController.java
+    │           │   ├── 📑 ProfileController.java
+    │           │   └── 📑 WorkspaceController.java
+    │           ├── 🗂 domain
+    │           │   ├── 📑 BodyMessage.java
+    │           │   ├── 📑 Chatroom.java
+    │           │   ├── 📑 ChatroomType.java
+    │           │   ├── 📑 EmailToken.java
+    │           │   ├── 📑 GoogleCode.java
+    │           │   ├── 📑 Member.java
+    │           │   ├── 📑 Message.java
+    │           │   ├── 📑 MessageType.java
+    │           │   ├── 📑 Profile.java
+    │           │   ├── 📑 Role.java
+    │           │   └── 📑 Workspace.java
+    │           ├── 🗂 repository
+    │           │   ├── 📑 ChatroomRepository.java
+    │           │   ├── 📑 EmailTokenRepository.java
+    │           │   ├── 📑 GoogleCodeRepsoitory.java
+    │           │   ├── 📑 MemberInviteRepository.java
+    │           │   ├── 📑 MemberRepository.java
+    │           │   ├── 📑 MessageRepository.java
+    │           │   ├── 📑 ProfileRepository.java
+    │           │   └── 📑 WorkspaceRepository.java
+    │           ├── 🗂 service
+    │           │   ├── 📑 ChatroomService.java
+    │           │   ├── 📑 CustomOauth2UserService.java
+    │           │   ├── 📑 EmailService.java
+    │           │   ├── 📑 EmailHandler.java
+    │           │   ├── 📑 MemberService.java
+    │           │   ├── 📑 MessageService.java
+    │           │   ├── 📑 ProfileService.java
+    │           │   ├── 📑 RedisService.java
+    │           │   └── 📑 WorkspaceService.java
+    │           ├── 🗂 util
+    │           │   ├── 📑 ErrorResponse.java
+    │           │   ├── 📑 GlobalExceptionHandler.java
+    │           │   ├── 📑 ResponseMessage.java
+    │           └── └── 📑 StatusEnum.java
+    └── 🗂 resources
+        ├── 🗂 templates
+        ├── 📑 application.properties
+        └── 📑 application-oauth.properties
+</code>
+</pre>
+
+