-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
159 additions
and
1 deletion.
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 +1,159 @@ | ||
| # COM-MA-SERVER | ||
|
|
||
| <div align="center"> | ||
| <h1>'Connect the Silent World and the World of Sounds'<br/>AI Camera-Based Sign Language Learning Service for Deaf Children - COM-MA</h1> | ||
| <img src="https://github.com/COM-MA/COM-MA-SERVER/assets/102026726/5cdd7168-3cee-4385-8944-c41d85ae18e4" alt="Slide 16_9 - 4"> | ||
| </div> | ||
|
|
||
| ## 📍Table of Contents | ||
| <hr> | ||
|
|
||
| 1. [💟 Backend Team Members](#-backend-team-members) | ||
| 2. [💟 Project Overview](#-project-overview) | ||
| 3. [💟 Key Features](#-key-features) | ||
| - [🔎 COM-MA Lens](#-com-ma-lens) | ||
| - [🏷️ Word Cards](#-word-cards) | ||
| - [💡 Quizzes](#-quizzes) | ||
| - [📚 Storybooks](#-storybooks) | ||
| 4. [💟 How to Run](#-how-to-run) | ||
| 5. [💟 Tech Stack](#-tech-stack) | ||
| - [🖥 Backend Server](#-backend-server) | ||
| 6. [💟 System Architecture](#-system-architecture) | ||
| - [📂 Folder Structure](#-folder-structure) | ||
| - [⚙️ Architecture Structure](#-architecture-structure) | ||
| - [📋 ERD](#-erd) | ||
| 7. [💟 Commit Convention](#-commit-convention) | ||
|
|
||
| <br> | ||
|
|
||
| ## 💟 Backend Team Members | ||
| <hr> | ||
|
|
||
| | Name 👩💻 | Major 🖥 | Contact mail 📧 | | ||
| |-------|------------------|--------------------| | ||
| | Haeyeon Song | Computer Science | hysong4u.gmail.com | | ||
|
|
||
| ## 💟 Project Overview | ||
| <hr> | ||
|
|
||
| > 2024 GOOGLE SOLUTION CHALLENGE - TEAM GREEN | ||
| `COM-MA` is an "AI camera-based sign language learning education platform" that helps deaf parents teach sign language directly to their children, <b>CODAs</b> (Children of Deaf Adults). | ||
| <br><br>The `COM-MA` Lens recognizes sign language and quickly converts it into learning materials for deaf parents. It offers these parents the opportunity to engage in sign language education with their children in everyday life. | ||
|
|
||
| <br /> | ||
|
|
||
| ## 💟 Key Features | ||
| <hr> | ||
|
|
||
|  | ||
|
|
||
| ### 🔎 COM-MA Lens | ||
| > AI-based camera recognizes sign language and provides images, text, and voice. | ||
| ### 🏷️ Word Cards | ||
| > Cards for learning sign language, text, and voice for each word. | ||
| ### 💡 Quizzes | ||
| > Create quizzes directly from saved word cards for educational use. | ||
| ### 📚 Storybooks | ||
| > Easily watch and educate with subtitles or sign language provided in storybooks. | ||
| <br /> | ||
|
|
||
| ## 💟 How to Run | ||
| <hr> | ||
|
|
||
| ```bash | ||
| # 1. Clone the project | ||
| git clone https://github.com/COM-MA/COM-MA-SERVER.git | ||
|
|
||
| # 2. Create the configuration file | ||
| vim COM-MA-SERVER/src/main/resources/application.yml | ||
|
|
||
| # 3. Build (execute at the project's root) | ||
| ./gradlew build -x test | ||
|
|
||
| # 4. Navigate to build/libs directory | ||
| cd COM-MA-SERVER/build/libs/ | ||
|
|
||
| # 5. Run the JAR file | ||
| java -jar comma-0.0.1-SNAPSHOT.jar | ||
|
|
||
| ``` | ||
| ## 💟 Tech Stack | ||
| <hr> | ||
|
|
||
| ### 🖥 Backend Server | ||
|
|
||
| | Role | Type | | ||
| |---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | Framework |  | | ||
| | Language |  | | ||
| | Build Tool |  | | ||
| | Database |  | | ||
| | Database Service |  | | ||
| | Cloud Storage |  | | ||
| | Cloud Server |  | | ||
| | Google API |   || Video API | ||
| | Web Server |  | | ||
|
|
||
| ## 💟 System Architecture | ||
| <hr> | ||
|
|
||
| ### 📂 Folder Structure | ||
| ``` | ||
| 📂 src | ||
| ┣ 📂 java.com.example.comma | ||
| ┃ ┣ 📂 domain | ||
| ┃ ┃ ┣ 📂 sample | ||
| ┃ ┃ ┃ ┣ 📂 controller | ||
| ┃ ┃ ┃ ┣ 📂 entity | ||
| ┃ ┃ ┃ ┣ 📂 dto | ||
| ┃ ┃ ┃ ┃ ┣ 📂 request | ||
| ┃ ┃ ┃ ┃ ┣ 📂 response | ||
| ┃ ┃ ┃ ┣ 📂 service | ||
| ┃ ┃ ┃ ┣ 📂 domain | ||
| ┃ ┃ ┃ ┣ 📂 repository | ||
| ┃ ┣ 📂 global | ||
| ┃ ┃ ┣ 📂 common | ||
| ┃ ┃ ┣ 📂 config | ||
| ┃ ┃ ┃ ┣ 📂 auth | ||
| ┃ ┃ ┣ 📂 error | ||
| ┃ ┃ ┃ ┣ 📂 dto | ||
| ┃ ┃ ┃ ┣ 📂 exception | ||
| ┃ ┃ ┃ ┣ 📂 handler | ||
| ┣ 📂 resources | ||
| ┃ ┣ application.yml | ||
| ┣ CommaApplication.class | ||
| ``` | ||
| <br /> | ||
| <hr> | ||
|
|
||
| ### ⚙️ Architecture Structure | ||
|  | ||
| <br /> | ||
|
|
||
| <hr> | ||
|
|
||
| ### 📋 ERD | ||
| <img width="783" alt="스크린샷 2024-02-21 오후 11 38 05" src="https://github.com/COM-MA/COM-MA-SERVER/assets/102026726/b1b8dc62-79bc-4060-84ca-fd969b539b77"> | ||
|
|
||
| <br /> | ||
|
|
||
| ## 💟 Commit Convention | ||
| <hr> | ||
|
|
||
| - ➕ [ADD] : Additional code or library, creation of new files excluding FEAT | ||
| - ✅ [MOD] : Code modification, internal file modification | ||
| - ✨ [FEAT] : Implementation of a new feature | ||
| - 🎗️ [UI] : UI work | ||
| - 🔀 [MERGE] : When merging different branches | ||
| - 🔨 [FIX] : Bug fixes and error resolution | ||
| - 🗑️ [DEL] : Removal of unnecessary code or files | ||
| - 📝 [DOCS] : Revision of README, WIKI, or other documentation | ||
| - ✏️ [CORRECT] : Small corrections such as grammar errors, type changes, or name changes | ||
| - 📦 [CHORE] : Changes in package structure, movement of files or code within the project | ||
| - ⏪️ [RENAME] : File renaming | ||
| - ♻️ [REFACTOR] : Major code refactoring | ||
| - 🛠 [SETTING] : Other configuration changes |