From 76f6d2899e7af3565b34816639d60264dff93dbc Mon Sep 17 00:00:00 2001
From: Jin Cheol <76617139+bik1111@users.noreply.github.com>
Date: Thu, 23 Nov 2023 17:56:59 +0900
Subject: [PATCH] Update README.md
---
README.md | 86 ++++++++++++++++++++++++++++++++++++++++++++++++++-----
1 file changed, 79 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index fae814b..ce47459 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,21 @@
+# BatShu
-## BatShu
+
-**적절한 리워드를 제공하여 자발적인 영상 제보를 유도하고, 필요한 영상 자료를 요청하고 제보할 수 있는 영상 공유 & 거래 플랫폼**
-- Service URL : https://batshu-c203f.firebaseapp.com
+### 🔉 프로젝트 소개
+> 밧슈, 필요한 순간, 필요한 사람에게
+>
+> BatShu | 적절한 리워드를 제공하여 자발적인 영상 제보를 유도하고, 필요한 영상 자료를 요청하고 제보할 수 있는 영상 공유 & 거래 플랫폼
+
-
- -
-------- + + + + + + ## Backend Tech Stack @@ -28,3 +34,69 @@ + + +## 📂 FOLDER STRUCTURE + +```java +. +├── 📁 Repository +│ ├── 🚑 Accident +│ │ └── AccidentRepository.ts +│ ├── 📬 Message +│ │ └── MessageRepository.ts +│ ├── 🔍 Observe +│ │ └── ObserveRepository.ts +│ ├── 🏠 Room +│ │ └── RoomRepository.ts +│ └── 👤 User +│ └── UserRepository.ts +├── 🚀 app.ts +├── 🔐 auth +│ ├── auth.ts +│ └── firebase.ts +├── 💬 chat +│ ├── chatSocket.ts +│ └── test.html +├── ⚙️ config +│ ├── database.ts +│ └── network.ts +├── 🎮 controller +│ ├── 🚑 Accident +│ │ └── AccidentController.ts +│ ├── 📬 Message +│ │ └── MessageController.ts +│ ├── 🔍 Observe +│ │ └── ObserveController.ts +│ ├── 🏠 Room +│ │ └── RoomController.ts +│ └── 👤 User +│ └── UserController.ts +├── 🎨 domain +│ └── response.ts +├── 🌐 ecosystem.config.ts +├── 📚 interface +│ ├── accident.ts +│ ├── both.ts +│ ├── chat.ts +│ └── observe.ts +├── 🚦 routers +│ ├── 🚑 AccidentRouter.ts +│ ├── 📬 MessageRouter.ts +│ ├── 🔍 ObserveRouter.ts +│ ├── 🏠 RoomRouter.ts +│ └── 👤 UserRouter.ts +├── ⚙️ service +│ ├── 🚑 Accident +│ │ └── AccidentService.ts +│ ├── 📬 Message +│ │ └── MessageService.ts +│ ├── 🔍 Observe +│ │ └── ObserveService.ts +│ ├── 🏠 Room +│ │ └── RoomService.ts +│ └── 👤 User +│ └── UserService.ts +└── 🛠️ utils +└── aws-s3.ts +```