-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #150 from mocacong/MOCACONG-493-README
docs: 모카콩 README 수정 작업
- Loading branch information
Showing
1 changed file
with
35 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,44 +1,50 @@ | ||
## 모각코하기 좋은 카페 지도 애플리케이션, 모카콩(MOCACONG) | ||
# 모각코하기 좋은 카페 지도 애플리케이션, 모카콩 <img alt="image" width="100" src="https://github.com/mocacong/Mocacong-Backend/assets/69844138/2058a9f5-447e-4a9b-8664-048f6792c955" align="left"> | ||
|
||
코딩하기 좋은 카페만 모아놓은 지도는 없을까? 고민했다면 모카콩! | ||
[![App Store](https://img.shields.io/badge/App_Store-0D96F6?style=flat-square&logo=app-store&logoColor=white)](https://apps.apple.com/kr/app/mocacong/id6446925939) | ||
[![Google Play](https://img.shields.io/badge/Google_Play-414141?style=flat-square&logo=google-play&logoColor=white)](https://play.google.com/store/apps/details?id=com.konkuk.mocacong&hl=en-KR) | ||
[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fmocacong%2FMocacong-Backend&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://hits.seeyoufarm.com) | ||
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=mocacong_Mocacong-Backend&metric=coverage)](https://sonarcloud.io/summary/new_code?id=mocacong_Mocacong-Backend) | ||
<br><br> | ||
|
||
<p align="center"> | ||
<img width="20%" height="400" alt="image" src="https://github.com/mocacong/Mocacong-Backend/assets/57135043/b8510091-a49a-439d-b067-eb92afe282ab"> | ||
<img width="20%" height="400" alt="image" src="https://github.com/mocacong/Mocacong-Backend/assets/57135043/ed9d723f-8161-4de4-9dae-3cfc2eea43b1"> | ||
<img width="20%" height="400" alt="image" src="https://github.com/mocacong/Mocacong-Backend/assets/57135043/614c6e44-9199-4042-9f29-b90f659dc613"> | ||
<img width="20%" height="400" alt="image" src="https://github.com/mocacong/Mocacong-Backend/assets/57135043/a81d4fbd-a4a4-4ebb-bc63-c8e0e815e2cb"> | ||
</p> | ||
## 🔎 Introduction | ||
![Group 301](https://github.com/mocacong/Mocacong-Backend/assets/69844138/008dad54-7ad5-4c5a-a614-927887457c32) | ||
<br> | ||
|
||
## 💻 Server Architecture | ||
### 📦 Dependency | ||
- Java 11, Junit 5 | ||
- Spring Boot 2.7.9 | ||
- MySQL | ||
|
||
- - - | ||
<br> | ||
|
||
### MVP 기능 | ||
### 🤲 AWS Architechture Diagram | ||
<p align="center"> | ||
<img width="90%" alt="image" src="https://github.com/mocacong/Mocacong-Backend/assets/57135043/328495c2-4332-45b5-b052-359c1ed4cbd2"> | ||
<img width="90%" alt="image" src="https://github.com/mocacong/Mocacong-Backend/assets/57135043/27e4efcd-1d2e-4aca-a7c2-d655dede951a"> | ||
</p> | ||
|
||
- - - | ||
<br> | ||
|
||
### 사용 기술스택 | ||
- `Language`: Java 11, JUnit 5 | ||
- `Framework`: Spring Boot 2.7.9 | ||
- `Database`: H2, Amazon RDS for MySQL, Amazon Elasticache for Redis | ||
- `ORM`: JPA (Spring Data JPA) | ||
- `Deploy`: Github Actions, Docker CI/CD | ||
- `Logging`: Logback, AWS Cloudwatch, AWS Lambda, Slack API | ||
- `API Docs`: SpringDoc Swagger 3 | ||
- `Performance Test`: nGrinder | ||
### 🛠️ Tech Stack | ||
#### Framework - <img src="https://img.shields.io/badge/Spring Boot-6DB33F?style=for-the-social&logo=Spring Boot&logoColor=white"> <img src="https://img.shields.io/badge/Gradle-02303A?style=for-the-social&logo=Gradle&logoColor=white"> | ||
#### Database - <img src ="https://img.shields.io/badge/H2 Database-blue"> <img src="https://img.shields.io/badge/Amazon RDS for MySQL-527FFF?style=for-the-sociak&logo=Amazon RDS&logoColor=white"> <img src="https://img.shields.io/badge/Amazon Elasticache for Redis-DC382D?style=for-the-sociak&logo=redis&logoColor=white"> | ||
#### ORM - <img src="https://img.shields.io/badge/Spring Data JPA-6DB33F?style=for-the-social&logo=Databricks&logoColor=white"> | ||
#### Deploy - <img src="https://img.shields.io/badge/Github Actions-2088FF?style=for-the-sociak&logo=githubactions&logoColor=white"> <img src="https://img.shields.io/badge/Docker-2496ED?style=for-the-sociak&logo=docker&logoColor=white"> | ||
#### Logging - <img src="https://img.shields.io/badge/Logback-25A162"> <img src="https://img.shields.io/badge/AWS Cloudwatch-FF4F8B?style=for-the-sociak&logo=amazoncloudwatch&logoColor=white"> <img src="https://img.shields.io/badge/AWS Lambda-FF9900?style=for-the-sociak&logo=awslambda&logoColor=white"> <img src="https://img.shields.io/badge/Slack API-4A154B?style=for-the-social&logo=slack&logoColor=white"> | ||
#### API Docs - <img src="https://img.shields.io/badge/SpringDoc Swagger 3-85EA2D?style=for-the-sociak&logo=swagger&logoColor=white"> | ||
#### Performance Test - <img src="https://img.shields.io/badge/nGrinder-orange"> | ||
#### Test - <img src="https://img.shields.io/badge/JUnit5-25A162?style=for-the-sociak&logo=junit5&logoColor=white"> <img src="https://img.shields.io/badge/RestAssured-25A162"> <img src="https://img.shields.io/badge/CodeCov-F01F7A?style=for-the-sociak&logo=codecov&logoColor=white"> | ||
|
||
- - - | ||
<br> | ||
|
||
### ERD | ||
## 🖇️ DataBase Schema | ||
<p align="center"> | ||
<img width="90%" alt="image" src="https://github.com/mocacong/Mocacong-Backend/assets/57135043/1def43a1-9271-4b1f-947a-0ff8ad07f77d"> | ||
<img width="90%" alt="image" src="https://github.com/mocacong/Mocacong-Backend/assets/69844138/969731a8-8852-46ba-9bdd-bbf515215b6d"> | ||
</p> | ||
|
||
- - - | ||
<br> | ||
|
||
### 서비스 아키텍처 | ||
<p align="center"> | ||
<img width="90%" alt="image" src="https://github.com/mocacong/Mocacong-Backend/assets/57135043/27e4efcd-1d2e-4aca-a7c2-d655dede951a"> | ||
</p> | ||
## 🙋🏻♂️ Server Engineers | ||
| Taehyeon | Jisoo | Jungwoo | | ||
|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| | ||
| <img src="https://avatars.githubusercontent.com/u/57135043?v=4" width="100" height="100" style="border-radius: 50%;"><br/><a href="https://github.com/kth990303" target="_blank"><img src="https://img.shields.io/badge/kth990303-181717?style=for-the-social&logo=github&logoColor=white"/></a> | <img src="https://avatars.githubusercontent.com/u/69844138?v=4" width="100" height="100" style="border-radius: 50%;"><br/><a href="https://github.com/Ji-soo708" target="_blank"><img src="https://img.shields.io/badge/Jisoo708-181717?style=for-the-social&logo=github&logoColor=white"/></a> |<img src="https://avatars.githubusercontent.com/u/76640167?s=400&u=a046b207b40b564a97db82bd2264b81727b50b77&v=4" width="100" height="100" style="border-radius: 50%;"><br/><a href="https://github.com/jung-woo-kim" target="_blank"><img src="https://img.shields.io/badge/jungwookim-181717?style=for-the-social&logo=github&logoColor=white"/></a>| |