[#9] docs(README.md): 서비스 소개 README v1 작성 (#10)

TEAM-BEAT · Jul 9, 2024 · e9e305e · e9e305e
1 parent 726e9d5
commit e9e305e
Showing 1 changed file with 119 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,120 @@
 # BEAT-Server
+# 💗 BEAT 💗
+
+```
+모두를 위한, 그래서 대학생을 위한 공연 예매 플랫폼
+```
+
+## 🥁 BEAT Server Developers 🥁
+
+|                                                                                                    이동훈                                                                                                    | 황혜린 | 
+|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| :---: | 
+|                                    <img width="200" alt="branch" src="https://github.com/TEAM-BEAT/BEAT-SERVER/assets/144998449/43e18ca0-5eca-46bf-a108-db662cb3ce9b">                                    |<img width="200" alt="branch" src="https://github.com/TEAM-BEAT/BEAT-SERVER/assets/144998449/e678429a-6a1b-4a0b-8457-7eb4b6f9de29"> | 
+|                                                                                [hoonyworld](https://github.com/hoonyworld)                                                                                | [hyerinhwang-sailin](https://github.com/hyerinhwang-sailin) |
+| prod 서버용 EC2. RDS 구축 <br> dev, prod 서버 github action CI 구축(dockerhub push까지) <br> Jenkins multibranch pipeline으로 dev 서버에서 dev, prod CD 및 <br> prod 서버에서 nginx 무중단 배포 구축<br> ERD 및 DB 설계 <br> Entity 초기 세팅 | AWS dev 서버 구축 <br> ERD 및 DB 설계 <br> 인증 / 인가 구현 (Redis) <br> 웹 발신 <br> Entity 초기 세팅 <br> 카카오 소셜 로그인 <br> Swagger 세팅 | 
+
+### 🏡 Git Convention
+[Git Convention](https://www.notion.so/jiwoothejay/git-convention-9bee60c3bb0a45f1913616b3e72b87b7)
+
+### 💬 Code Convention
+[Code Convention](https://www.notion.so/jiwoothejay/spring-code-convention-15be5fc539a14196b2c360ebfb373856)
+
+### 🌳 Commit Convention
+[Commit Convention](https://www.notion.so/jiwoothejay/issue-pr-templates-44f118ed82904febae246518ef150e25)
+
+### 📁 Foldering
+```
+src
+	├── main
+	│   ├── java
+	│   │   └── com
+	│   │       └── beat
+	│   │           ├── domain
+	│   │           │   ├── booking
+	│   │           │   │   ├── api
+	│   │           │   │   ├── application
+	│   │           │   │   ├── dao
+	│   │           │   │   ├── domain
+	│   │           │   │   └── exception
+	│   │           │   ├── cast
+	│   │           │   │   ├── api
+	│   │           │   │   ├── application
+	│   │           │   │   ├── dao
+	│   │           │   │   ├── domain
+	│   │           │   │   └── exception
+	│   │           │   ├── member
+	│   │           │   │   ├── api
+	│   │           │   │   ├── application
+	│   │           │   │   ├── dao
+	│   │           │   │   ├── domain
+	│   │           │   │   └── exception
+	│   │           │   ├── performance
+	│   │           │   │   ├── api
+	│   │           │   │   ├── application
+	│   │           │   │   ├── dao
+	│   │           │   │   ├── domain
+	│   │           │   │   └── exception
+	│   │           │   ├── promotion
+	│   │           │   │   ├── api
+	│   │           │   │   ├── application
+	│   │           │   │   ├── dao
+	│   │           │   │   ├── domain
+	│   │           │   │   └── exception
+	│   │           │   ├── schedule
+	│   │           │   │   ├── api
+	│   │           │   │   ├── application
+	│   │           │   │   ├── dao
+	│   │           │   │   ├── domain
+	│   │           │   │   └── exception
+	│   │           │   ├── staff
+	│   │           │   │   ├── api
+	│   │           │   │   ├── application
+	│   │           │   │   ├── dao
+	│   │           │   │   ├── domain
+	│   │           │   │   └── exception
+	│   │           │   ├── users
+	│   │           │   │   ├── api
+	│   │           │   │   ├── application
+	│   │           │   │   ├── dao
+	│   │           │   │   ├── domain
+	│   │           │   │   └── exception
+	│   │           ├── global
+	│   │           │   ├── common
+	│   │           │   │   ├── config
+	│   │           │   │   ├── dto
+	│   │           │   │   └── exception
+	│   │           │   │       ├── base
+	│   │           │   │       └── handler
+	│   │           │   ├── auth
+	│   │           │   │   ├── feign
+	│   │           │   │   │   └── kakao
+	│   │           │   │   ├── filter
+	│   │           │   │   ├── jwt
+	│   │           │   │   ├── redis
+	│   │           │   │   ├── security
+	│   │           │   ├── external
+	│   │           │   │   ├── discord
+	│   │           │   │   │   ├── exception
+	│   │           │   │   │   └── model
+	│   │           │   │   ├── s3
+	│   │           │   │   │   ├── dto
+	│   │           │   │   │   ├── exception
+	│   │           │   │   │   └── service
+	│   │           ├── infra
+	│   │           │   ├── email
+	│   │           │   └── sms
+	│   │           └── BeatApplication
+	│   └── resources
+	│       ├── application.yml
+	│       ├── application-dev.yml
+	│       ├── application-local.yml
+	│       └── application-prod.yml
+```
+
+## 🔗 ERD
+
+## 📄 API 명세서
+
+## 🛠️ Tech
+
+## 🔨 Architecture