Merge pull request ChwitKey#121 from ChwitKey/chore/117-readme

ChwitKey#117 chwitkey server readme.md

Author: dangnak2

ALM.png

@@ -1 +1,191 @@
-# Cherrypick-Server
+## ChwitKey-Server
+취트키 서버 레포입니다.
+
+<div align="center">
+
+# 🔑 취업 성공의 치트키, 취트키!
+
+ <img width="200px" src="https://github.com/Cherrypickk/ChwitKey-Android/assets/97820109/4620b760-81d1-4c40-827e-cfad14dd6f13"/>  <img width="200px" src="https://github.com/Cherrypickk/ChwitKey-Android/assets/97820109/687e759a-8b00-4a58-a523-eae0eb2dbbb6"/>  <img width="200px" src="https://github.com/Cherrypickk/ChwitKey-Android/assets/97820109/c6876d12-0414-4f86-aa0c-9ba225453c47"/> 
+
+
+## 2023.07 - 2023. 08
+
+##### 2023. 08. 22 취트키 version 1.0 Google PlayStore 출시 신청
+
+### 협업
+
+<img src="https://img.shields.io/badge/PM-008FC7?style=flat&logo=microsoft&logoColor=white"/>
+<img src="https://img.shields.io/badge/Design-FF6550?style=flat&logo=adobeillustrator&logoColor=white"/>
+<img src="https://img.shields.io/badge/Android-9999FF?style=flat&logo=android&logoColor=white"/>
+<img src="https://img.shields.io/badge/SpringBoot-0ABF53?style=flat&logo=spring&logoColor=white"/>
+
+### 추후 지속적인 업데이트 및 리팩토링 예정 🔥
+
+
+
+<br>
+
+</div>
+
+## *****Description*****
+
+
+🔑 ･ *****관심 직군과 키워드를 설정하여 필요한 기사를 한 눈에 볼 수 있어요***** ･ 🔑
+- 관심 직군을 최대 3개까지 선택!
+- 관심 키워드를 최대 10개까지 선택!
+- 인기순, 최신순, 오래된 순으로 정렬해서 확인해요!
+- 궁금한 기사는 바로 검색할 수도 있어요!
+
+<br>
+
+🔑 ･ *****저장하고 싶은 기사는 스크랩하고, 공유해요***** ･ 🔑
+- 필요한 기사는 스크랩하여 모아 볼 수 있어요!
+- 공유하고 싶은 기사는 링크를 전달할 수 있어요!
+
+<br>
+
+🔑 ･ *****GPT는 내 친구! 기사 별로 GPT와의 채팅이 가능해요!***** ･ 🔑
+- 내가 봤던 기사를 GPT가 요약해줘요!
+- 기사에 관련된 질문이라면 얼마든지 GPT와 채팅할 수 있어요!
+
+<br>
+<br>
+<br>
+
+
+<div align="center">
+
+# 👤 *****Contributor*****
+<div align="center">
+<table style="font-weight : bold">
+      <tr>
+         <td align="center">
+          <a href="https://github.com/arinming">                 
+                  <img alt="dangnak2" src="https://avatars.githubusercontent.com/dangnak2" width="100" />            
+              </a>
+          </td>
+          <td align="center">
+              <a href="https://github.com/JunYeong0314">                 
+                  <img alt="witwint" src="https://avatars.githubusercontent.com/witwint" width="100" />            
+              </a>
+          </td>
+          <td align="center">
+              <a href="https://github.com/syeonnn">                 
+                  <img alt="letskuku" src="https://avatars.githubusercontent.com/letskuku" width="100" />            
+              </a>
+          </td>
+      </tr>
+      <tr>
+          <td align="center">김민기</td>
+          <td align="center">문석범</td>
+          <td align="center">이유정</td>
+      </tr>
+  </table>
+</div>
+
+<br>
+
+# 📱 *****Preview*****
+
+|                                                                    로그인                                                                     |                                                                    회원 등록                                                                     |                                                            직군별 기사 리스트                                                            |                                                            키워드별 기사 리스트                                                             |
+|:----------------------------------------------------------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------:|
+|       <img width="200px" src="https://github.com/Cherrypickk/ChwitKey-Android/assets/97820109/7c99a578-37b5-449f-824d-77062d6a7bb7"/>        |        <img width="200px" src="https://github.com/Cherrypickk/ChwitKey-Android/assets/97820109/08db55cc-a475-480a-a44c-f6ecc9aa9852"/>        | <img width="200px" src="https://github.com/Cherrypickk/ChwitKey-Android/assets/97820109/16abe72e-3139-4679-b0a8-aa1c3466db45"/> | <img width="200px" src="https://github.com/Cherrypickk/ChwitKey-Android/assets/97820109/677dc57a-3e88-4f7c-bee7-d2b1fc8611aa"/> |
+
+|                                                             기사 검색                                                               |                                                             기사 상세 페이지                                                              |                                                               키워드 등록                                                               |                                                            마이페이지                                                              |
+|:---------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------:|
+| <img width="200px" src="https://github.com/Cherrypickk/ChwitKey-Android/assets/97820109/cbb7a8ca-b817-45d0-9015-6b2a5d960e53"/> | <img width="200px" src="https://github.com/Cherrypickk/ChwitKey-Android/assets/97820109/42569374-7fc1-4eca-80c0-91c717327ca8"/> | <img width="200px" src="https://github.com/Cherrypickk/ChwitKey-Android/assets/97820109/ed22f2bb-78ca-4cf9-b8cd-e50d90c263a7"/> | <img width="200px" src="https://github.com/Cherrypickk/ChwitKey-Android/assets/97820109/d098dfcf-e0fb-4e3d-af46-3199bfc1abc0"/> |
+
+|                                                              마이페이지 상세                                                               |                                                             지피티                                                              |                                                               스크랩 리스트                                                               |                                                           직군 선택                                                             |
+|:---------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------:|
+| <img width="200px" src="https://github.com/Cherrypickk/ChwitKey-Android/assets/97820109/cbe03e0c-dd12-4af4-a984-6d82692d8cd2"/> | <img width="200px" src="https://github.com/Cherrypickk/ChwitKey-Android/assets/97820109/ad37f475-d05e-4ffa-bc34-460cbd869cda"/> | <img width="200px" src="https://github.com/Cherrypickk/ChwitKey-Android/assets/97820109/9cba6fcf-828a-4dc2-92cc-4251740fd465"/> | <img width="200px" src="https://github.com/Cherrypickk/ChwitKey-Android/assets/97820109/d1f58550-0e98-4115-ba05-c0ac92dc6dbb"/> |
+
+
+
+
+
+</br>
+
+# 🔎 ***Architecture***
+
+
+### ALM
+
+![ALM.png](ALM.png)
+ 
+<br>
+
+
+### CI / CD
+
+
+![img.png](img.png)
+
+
+<br>
+
+# 📕 *****Convention*****
+
+[우리의 협업 방식 ✅ Link](https://bustling-iguanodon-674.notion.site/f89ae6a682c144f7ae0b69efc670bf77)
+
+
+<br>
+
+
+# ⚒️ ***Tech***
+
+
+### Backend
+<img src="https://img.shields.io/badge/java-007396?style=for-the-badge&logo=java&logoColor=white"> 
+<img src="https://img.shields.io/badge/springboot-6DB33F?style=for-the-badge&logo=springboot&logoColor=white">  <img src="https://img.shields.io/badge/spring data jpa-6DB33F?style=for-the-badge&logoColor=white"> <img src="https://img.shields.io/badge/hibernate-59666C?style=for-the-badge&logo=hibernate&logoColor=white"> <img src="https://img.shields.io/badge/gradle-02303A?style=for-the-badge&logo=gradle&logoColor=white">
+<img alt="Python" src ="https://img.shields.io/badge/jwt-black.svg?&style=for-the-badge&logo=jwt&logoColor=white"/>
+
+### DB
+<img src="https://img.shields.io/badge/amazon rds-527FFF?style=for-the-badge&logo=amazonrds&logoColor=white"> <img src="https://img.shields.io/badge/mysql-4479A1?style=for-the-badge&logo=mysql&logoColor=white"> <img src="https://img.shields.io/badge/jasypt-0769AD?style=for-the-badge&logoColor=white"> <img src="https://img.shields.io/badge/amazon s3-569A31?style=for-the-badge&logo=amazons3&logoColor=white">
+
+### CI/CD
+<img src="https://img.shields.io/badge/jenkins-D24939?style=for-the-badge&logo=jenkins&logoColor=white"> <img src="https://img.shields.io/badge/docker-2496ED?style=for-the-badge&logo=docker&logoColor=white"> <img src="https://img.shields.io/badge/docker hub-2496ED?style=for-the-badge&logo=docker&logoColor=white"> 
+
+### Deploy
+<img src="https://img.shields.io/badge/amazon ec2-FF9900?style=for-the-badge&logo=amazon ec2&logoColor=white"> 
+
+### Develop Tool
+<img src="https://img.shields.io/badge/intelliJ-000000?style=for-the-badge&logo=intellij idea&logoColor=white"> <img src="https://img.shields.io/badge/postman-FF6C37?style=for-the-badge&logo=postman&logoColor=white"> <img src="https://img.shields.io/badge/github-181717?style=for-the-badge&logo=github&logoColor=white"> <img src="https://img.shields.io/badge/git-F05032?style=for-the-badge&logo=git&logoColor=white"> 
+
+
+<br>
+
+
+## 📁 *****Foldering*****
+
+</div>
+
+
+```
+📂 com.ChwitKey
+┣ 📂 article
+┃ ┣ 📂 application
+┃ ┣ 📂 domain
+┃ ┣ 📂 dto
+┃ ┣ 📂 exception
+┃ ┣ 📂 presentation
+┣ 📂 chat
+┃ ┣ 📂 application
+┃ ┣ 📂 domain
+┃ ┣ 📂 dto
+┃ ┣ 📂 exception
+┃ ┣ 📂 presentation
+┣ 📂 global
+┃ ┣ 📂 config
+┃ ┣ 📂 dto
+┃ ┣ 📂 entity
+┃ ┣ 📂 presentation
+┃ ┣ 📂 resolver
+┃ ┣ 📂 utils
+┣ 📂 member
+┃ ┣ 📂 application
+┃ ┣ 📂 domain
+┃ ┣ 📂 dto
+┃ ┣ 📂 exception
+┃ ┣ 📂 presentation
+```
+