Skip to content

Commit

Permalink
πŸ“„ docs: Create README.md (#133)
Browse files Browse the repository at this point in the history
* Create README.md

* Update README.md
  • Loading branch information
stophwan authored Sep 26, 2024
1 parent 330f883 commit 1302f8c
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# 블루밍 <img src="https://github.com/user-attachments/assets/66d439a8-4bbf-4ea9-b7ac-f4bd09dc23e9" align=left width=100>

> 초보 식집사λ₯Ό μœ„ν•œ 반렀 식물 κ°€μ΄λ“œπŸŒ± &nbsp;&nbsp;
---

## ☘️ Introduce
![1](https://github.com/user-attachments/assets/7e750aef-a88f-41d4-8b73-a8a4734a36e6)
![1](https://github.com/user-attachments/assets/5f27239b-c761-47b1-8694-87a7f55ddaa4)
![2](https://github.com/user-attachments/assets/801f0b29-370b-4caa-921b-1b640d813e0b)
![3](https://github.com/user-attachments/assets/244b5a4b-65a7-4eca-bb6b-e05287647002)
![4](https://github.com/user-attachments/assets/d7019136-c848-4201-a2c8-63b1beaf1d9c)

## πŸ–₯️ Tech Stack
### Application
<img src="https://img.shields.io/badge/Kotlin-7F52FF?style=for-the-social&logo=Kotlin&logoColor=white"> <img src="https://img.shields.io/badge/Gradle-02303A?style=for-the-social&logo=Gradle&logoColor=white"> <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/Spring Data JPA-6DB33F?style=for-the-social&logo=Databricks&logoColor=white">

### Database
<img src="https://img.shields.io/badge/MySQL-4479A1?style=for-the-social&logo=MySQL&logoColor=white"> <img src="https://img.shields.io/badge/Redis-FF4438?style=for-the-social&logo=redis&logoColor=white">

### CI/CD
<img src="https://img.shields.io/badge/Github Actions-2088FF?style=for-the-social&logo=Github Actions&logoColor=white"> <img src="https://img.shields.io/badge/Docker-2496ED?style=for-the-social&logo=Docker&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">

### Docs
<img src="https://img.shields.io/badge/ Swagger-6DB33F?style=for-the-social&logo=swagger&logoColor=white">


## πŸ“‚ Directory Structure

```
β”œβ”€β”€ .github # github actions 파일
β”œβ”€β”€ api # API μ„œλ²„
β”œβ”€β”€ batch # Batch μ„œλ²„
β”œβ”€β”€ client # μ™ΈλΆ€ api 호좜 λͺ¨λ“ˆ(Open API, FCM, OAuth)
β”œβ”€β”€ common # 곡톡 λͺ¨λ“ˆ(util, error...)
β”œβ”€β”€ docker # 둜컬 도컀 ν™˜κ²½ μ„€μ •
β”œβ”€β”€ domain # 도메인 λͺ¨λ“ˆ(domain, repository)
β”‚ └── core # JPA + MySQL λͺ¨λ“ˆ
β”‚ └── redis # Redis λͺ¨λ“ˆ
β”œβ”€β”€ monitoring # λͺ¨λ‹ˆν„°λ§(prometheus, grafana, loki)
```

## πŸ‘₯ Contributors
| μ •μ§€ν™˜ | 이창근 |
|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| <a href="https://github.com/stophwan" target="_blank"><img src="https://avatars.githubusercontent.com/u/64758861?v=4" width="100" height="100" style="border-radius: 5%;"><br/></a> | <a href="https://github.com/Dompoo" target="_blank"><img src="https://avatars.githubusercontent.com/u/46932235?v=4" width="100" height="100" style="border-radius: 5%;"></a> |

0 comments on commit 1302f8c

Please sign in to comment.