-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
📝 docs(readme): update README (#273)
* 📝 docs(readme): add introduction by referencing on Behance * 📝 docs(readme): add architecture * 📝 docs(readme): create user-flow * 📝 docs(readme): add server engineers profile * 📝 docs(readme): add hits badge * 📝 docs(readme): add repository * 📝 chore: add linked-in url * 📝 docs(readme): add ERD * 📝 docs(readme): add tech stack * 📝 docs(readme): change order * 📝 docs(readme): move user flow * 🔥 docs(readme): delete introduction images * 📝 docs(readme): add back introducion image * 📝 docs(readme): optimize image size * 📝 docs(readme): reload my-page image
- Loading branch information
Showing
1 changed file
with
63 additions
and
33 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,47 +1,77 @@ | ||
| ## 스트릿 드랍 (Street Drop) | ||
| # Street Drop(스트릿 드랍) <a href="https://apps.apple.com/kr/app/%EC%8A%A4%ED%8A%B8%EB%A6%BF%EB%93%9C%EB%9E%8D-street-drop/id6450315928"><img src="https://github.com/siyeonSon/ReadmeImage/blob/main/street-drop-server/app-logo.png" align="left" width="100"></a> | ||
|
|
||
| [](https://hits.seeyoufarm.com) | ||
| [](https://codecov.io/gh/depromeet/street-drop-server) | ||
| [](https://github.com/depromeet/street-drop-server/actions) | ||
|
|
||
| ### 서비스 소개 | ||
| 내가 현재 있는 장소에 따라 음악을 공유하고 추천받는 서비스 **스트릿 드랍**입니다. | ||
| ## 💁♂️ Introduction | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| ### 서비스 기능 | ||
| - 지도에서 코멘트와 함께 음악을 탐색할 수 있습니다. | ||
| - 현재 위치에 음악을 드랍해 공유할 수 있습니다. | ||
| - 반경 내에 있는 음악을 듣고 반응할 수 있습니다. | ||
| - 동별, 시별, 지역별로 드랍된 음악의 개수를 파악할 수 있습니다. | ||
| - 드랍한 음악을 듣고 좋아요를 남길 수 있습니다. | ||
| - 음악을 드랍한 개수에 따라 레벨을 올릴 수 있습니다. | ||
| - 마이 페이지에서 드랍한 음악 내역과 좋아요를 누른 음악 내역을 확인할 수 있습니다. | ||
| - 푸시 알람을 통해 공지 사항이나 이벤트 등에 대한 알람을 받을 수 있습니다. | ||
| <p align="center"> | ||
| <a href="https://apps.apple.com/kr/app/%EC%8A%A4%ED%8A%B8%EB%A6%BF%EB%93%9C%EB%9E%8D-street-drop/id6450315928" style="display: inline-block; overflow: hidden; border-radius: 13px; width: 250px; height: 83px;"><img src="https://tools.applemediaservices.com/api/badges/download-on-the-app-store/black/en-us?size=250x83&releaseDate=1641254400&h=ddfff0c3bd61d9f88f53494b401881d3" alt="Download on the App Store" style="border-radius: 13px; width: 250px; height: 83px;"></a> | ||
| </p> | ||
|
|
||
| ## 💁♀️ User Flow | ||
|  | ||
|
|
||
| [//]: # () | ||
| [//]: # () | ||
| [//]: # () | ||
| [//]: # () | ||
| [//]: # () | ||
| [//]: # () | ||
| [//]: # () | ||
| ## 👜 Repository | ||
| | [street-drop-iOS](https://github.com/depromeet/street-drop-iOS) | [street-drop-server](https://github.com/depromeet/street-drop-server) | | ||
| |:--------:|:--------:| | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
| ## 🖥️ 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"> | ||
|
|
||
| ### ORM | ||
| <img src="https://img.shields.io/badge/Spring Data JPA-6DB33F?style=for-the-social&logo=Databricks&logoColor=white"> | ||
|
|
||
| ### 서비스 아키텍쳐 | ||
|  | ||
| ### Authorization | ||
| <img src="https://img.shields.io/badge/Spring Security-6DB33F?style=for-the-social&logo=springsecurity&logoColor=white"> <img src="https://img.shields.io/badge/JSON Web Tokens-000000?style=for-the-social&logo=JSON Web Tokens&logoColor=white"> | ||
|
|
||
| ### 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/CodeCov-F01F7A?style=for-the-sociak&logo=codecov&logoColor=white"> | ||
|
|
||
| ### Database | ||
| <img src="https://img.shields.io/badge/MySQL-4479A1.svg?style=for-the-social&logo=MySQL&logoColor=white"> <img src="https://img.shields.io/badge/MongoDB-234ea94b.svg?logo=mongodb&logoColor=white&style=for-the-social"> <img src="https://img.shields.io/badge/Redis-DC382D.svg?logo=redis&logoColor=white&style=for-the-social"> | ||
|
|
||
| ### 앱스토어 다운로드 | ||
| **지금 바로 스트릿 드랍을 만나보세요!** | ||
| <p align="center"> | ||
| <a href="https://apps.apple.com/kr/app/%EC%8A%A4%ED%8A%B8%EB%A6%BF%EB%93%9C%EB%9E%8D-street-drop/id6450315928" style="display: inline-block; overflow: hidden; border-radius: 13px; width: 250px; height: 83px;"><img src="https://tools.applemediaservices.com/api/badges/download-on-the-app-store/black/en-us?size=250x83&releaseDate=1641254400&h=ddfff0c3bd61d9f88f53494b401881d3" alt="Download on the App Store" style="border-radius: 13px; width: 250px; height: 83px;"></a> | ||
| </p> | ||
| ### Message Queue | ||
| <img src="https://img.shields.io/badge/RabbitMQ-FF6600?style=for-the-social&logo=rabbitmq&logoColor=white"> | ||
|
|
||
| ### AWS | ||
| <img src ="https://img.shields.io/badge/AWS EC2-FF9900?style=for-the-social&logo=amazonec2&logoColor=white"> <img src ="https://img.shields.io/badge/AWS S3-69A31?style=for-the-social&logo=amazons3&logoColor=white"> <img src="https://img.shields.io/badge/AWS RDS-527FFF?style=for-the-social&logo=amazonrds&logoColor=white"> <img src ="https://img.shields.io/badge/AWS Cloud Watch-FF4F8B?style=for-the-social&logo=amazoncloudwatch&logoColor=white"> <img src ="https://img.shields.io/badge/AWS Lambda-F9900?style=for-the-social&logo=awslambda&logoColor=white"> | ||
|
|
||
| ### Monitoring | ||
| <img src="https://img.shields.io/badge/Prometheus-E6522C?style=for-the-social&logo=prometheus&logoColor=white"> <img src="https://img.shields.io/badge/Grafana-F46800?style=for-the-social&logo=grafana&logoColor=white"> <img src="https://img.shields.io/badge/Slack-4A154B?style=for-the-social&logo=slack&logoColor=white"> | ||
|
|
||
| ### API Documentation | ||
| <img src="https://img.shields.io/badge/ Swagger-6DB33F?style=for-the-social&logo=swagger&logoColor=white"> | ||
|
|
||
| ### Admin Web Page | ||
| <img src="https://img.shields.io/badge/React-61DAFB?style=for-the-social&logo=react&logoColor=white"> <img src="https://img.shields.io/badge/Node.js-339933?style=for-the-social&logo=node.js&logoColor=white"> | ||
|
|
||
| ### Notification | ||
| <img src="https://img.shields.io/badge/Firebase Cloud Messaging-FFCA28?style=for-the-social&logo=firebase&logoColor=white"> | ||
|
|
||
| ## 🚎 Architecture | ||
|  | ||
|
|
||
| ## 📈 ERD | ||
|  | ||
|
|
||
| ## 🧑💻 Server Engineers | ||
| | Profile | Contact | Github | | ||
| |:---:|:---:|:---:| | ||
| | <img src="https://avatars.githubusercontent.com/u/17813930?v=4" width="200" height="200"> | <a href="https://www.linkedin.com/in/young-yun-60aa94163" target="_blank"><img src="https://img.shields.io/badge/윤_영-%230077B5.svg?style=for-the-socail&logo=linkedin&logoColor=white"/></a> | <a href="https://github.com/yunyoung1819" target="_blank"><img src="https://img.shields.io/badge/yunyoung1819-181717?style=for-the-social&logo=github&logoColor=white"/></a> | | ||
| | <img src="https://avatars.githubusercontent.com/u/80201773?v=4" width="200" height="200"> | <a href="https://www.linkedin.com/in/seonghun" target="_blank"><img src="https://img.shields.io/badge/정_성_훈-%230077B5.svg?style=for-the-social&logo=linkedin&logoColor=white"/></a> | <a href="https://github.com/seonghun-dev" target="_blank"><img src="https://img.shields.io/badge/seonghun_dev-181717?style=for-the-social&logo=github&logoColor=white"/></a> | | ||
| | <img src="https://avatars.githubusercontent.com/u/87802191?s=400&u=a046b207b40b564a97db82bd2264b81727b50b77&v=4" width="200" height="200"> | <a href="https://www.linkedin.com/in/siyeonson" target="_blank"><img src="https://img.shields.io/badge/손_시_연-%230077B5.svg?style=for-the-social&logo=linkedin&logoColor=white"/></a> | <a href="https://github.com/siyeonSon" target="_blank"><img src="https://img.shields.io/badge/siyeonSon-181717?style=for-the-social&logo=github&logoColor=white"/></a> | |