-
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
1 parent
55dbea1
commit 0180905
Showing
1 changed file
with
58 additions
and
109 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,100 +1,61 @@ | ||
# Mody | ||
|
||
> "๋ชจ๋(Mode)"์ "๋ฒ๋(Buddy)"์ ๊ฒฐํฉ์ผ๋ก ๋ง๋ค์ด์ง ์ด ์ด๋ฆ์, ๋น์ ์ **๋ผ์ดํ์คํ์ผ๊ณผ ๊ฐ์ฑ์ ๋ฐ์ํ๋ ์ต์ ์ '๋ชจ๋'๋ฅผ ๋ฐ๊ฒฌํ๋๋ก ๋๋ ์น๊ตฌ**๋ฅผ ๋ปํฉ๋๋ค. | ||
## ํ๋ก์ ํธ ์๊ฐ | ||
|
||
- ๊ณ ๊ฐ์ ์ฒดํ, ์ทจํฅ, ๋ผ์ดํ์คํ์ผ ๋ฐ์ดํฐ๋ฅผ ๊ธฐ๋ฐ์ผ๋ก ๋ง์ถคํ ์คํ์ผ๋ง ๊ฒฝํ์ ์ ๊ณตํฉ๋๋ค. | ||
- ๋จ์ํ ์ถ์ฒ์ ๋์ด, ๊ณ ๊ฐ ์ค์ค๋ก ์คํ์ผ๋ง ๋ฅ๋ ฅ์ ๊ธฐ๋ฅผ ์ ์๋๋ก ๋๋ ์๋น์ค์ ๋๋ค. | ||
|
||
## Member | ||
> ๊ณ ๊ฐ์ ์ฒดํ, ์ทจํฅ, ๋ผ์ดํ์คํ์ผ ๋ฐ์ดํฐ๋ฅผ ๊ธฐ๋ฐ์ผ๋ก ๋ง์ถคํ ์คํ์ผ๋ง ๊ฒฝํ์ ์ ๊ณตํฉ๋๋ค. | ||
> ๋จ์ํ ์ถ์ฒ์ ๋์ด, ๊ณ ๊ฐ ์ค์ค๋ก ์คํ์ผ๋ง ๋ฅ๋ ฅ์ ๊ธฐ๋ฅผ ์ ์๋๋ก ๋๋ ์๋น์ค์ ๋๋ค. | ||
<div align=center> | ||
|
||
| Backend | Backend | | ||
|:-----------------------------------------:|:-----------------------------------------------:| | ||
[๋ฐ๋๊ท](https://github.com) | <img width="173" alt="image" src="https://github.com/user-attachments/assets/488fec06-d15c-444b-a7ac-9b6f0c633839" /> | ||
[๊น์ฌํ](https://github.com/jher235) | <img width="172" alt="image" src="https://github.com/user-attachments/assets/021ca13c-4e3c-4db8-aebb-5f920c3a6338" /> | ||
[์์ํจ](https://github.com/seoshinehyo) | <img width="164" alt="image" src="https://github.com/user-attachments/assets/6422ab4d-c39f-43e0-bb8c-e065dd2f4635" /> | ||
[๊น์ฑ์ฑ](https://github.com/) | <img width="164" alt="image" src="https://github.com/user-attachments/assets/180c4941-1370-482e-a626-21324fcf1ef9" /> | ||
[์ต์ค์](https://github.com/yunseo02) | <img width="213" alt="image" src="https://github.com/user-attachments/assets/6ae5daf0-5ca5-4581-82c4-1cbc3eb78336" /> | ||
|
||
|
||
 | ||
 | ||
|
||
</div> | ||
|
||
## ๊ฐ๋ฐ ๊ธฐ๊ฐ | ||
|
||
|
||
## ํ๋ก์ ํธ ๊ธฐ๋ฅ | ||
1. ์ข ํฉ ํจ์ ์คํ์ผ ์ปจ์คํ | ||
* ์ฒดํ ๋ถ์ | ||
* ์คํ์ผ ์ถ์ฒ | ||
* ํจ์ ์์ดํ ์ถ์ฒ | ||
* ๋ธ๋๋ ์ถ์ฒ | ||
2. ๋ฐ์ผ๋ฆฌ ํจ์ ์ถ์ฒ | ||
* ๋ ์จ ๊ธฐ๋ฐ ์ถ์ฒ | ||
* ์ผ์ ๋ฐ ๋ผ์ดํ์คํ์ผ ๋ฐ์ ์ถ์ฒ | ||
3. ๋ถ๊ฐ ๊ธฐ๋ฅ | ||
* ์คํ์ผ๋ง ํ ์ ๊ณต | ||
* ์ผํ ์ฐ๊ณ ๊ธฐ๋ฅ | ||
* ์ ์ฅ ๋ฐ ๋น๊ต ๊ธฐ๋ฅ | ||
* ์คํ์ผ ์ปค๋ฎค๋ํฐ | ||
4. ๊ธฐ๋ฅ ๊ธฐ๋ ํจ๊ณผ | ||
* ์๊ฐ ์ ์ฝ: ๊ณ ๊ฐ์ด ์คํ์ผ ๊ณ ๋ฏผ์ ์๋ชจํ๋ ์๊ฐ์ ํ๊ธฐ์ ์ผ๋ก ๋จ์ถ | ||
* ๊ฐ์ฑ ํํ: ํ์ผ์ ์ธ ์คํ์ผ์์ ๋ฒ์ด๋, ๊ฐ์ธ์ ๊ฐ์ฑ๊ณผ ๋งค๋ ฅ์ ๋๋ณด์ด๊ฒ ํจ | ||
* ํธ๋ฆฌํ ์ผํ: ์ถ์ฒ๊ณผ ์ผํ์ ํ ๋ฒ์ ํด๊ฒฐํ์ฌ ๊ตฌ๋งค ์คํจ์จ์ ๋ฎ์ถค | ||
* ์ง์์ ์ธ ์ฑ์ฅ: ๊ณ ๊ฐ ์ค์ค๋ก ์คํ์ผ๋ง ์ค๋ ฅ์ ํค์ ํจ์ ๊ทผ์ก์ ๊ฐํ | ||
|
||
## How to use | ||
|
||
```sh | ||
curl -X POST http://localhost/api/v1/user/signup \ | ||
-H "Content-Type: application/json" \ | ||
-d '{"user_code":"admin","password":"admin","user_name":"admin","user_email":"admin","department":"admin","semester":1,"major":"admin","phone_number":"010-1234-5678"}' | ||
``` | ||
|
||
ํฐ๋ฏธ๋ ํน์ CMD ์ฐฝ์ ๋ค์ ๋ช ๋ น์ด๋ฅผ ํตํด์ admin ๊ณ์ ์ ๋ํด ํ์๊ฐ์ ์ ์งํํฉ๋๋ค. | ||
|
||
### client | ||
|
||
```bash | ||
yarn install | ||
yarn start | ||
``` | ||
|
||
ํด๋ผ์ด์ธํธ ๋๋ ํ ๋ฆฌ์์ ์์ ๊ฐ์ ๋ช ๋ น์ด๋ฅผ ํตํด ์คํํฉ๋๋ค. | ||
|
||
## ๊ฐ๋ฐ ํ๊ฒฝ | ||
## Member | ||
|
||
- OS: MacOS, Ubuntu | ||
- Code Editor: Visual Studio Code, IntelliJ, PyCharm | ||
- Language: Html, CSS, JavaScript, TypeScript, Python | ||
- Collaboration Tool: Notion, Github, Slack | ||
<br> | ||
| ๋ฐ๋๊ท | ๊น์ฌํ | ์์ํจ | ๊น์ฑ์ฑ | ์ต์ค์ | | ||
|:---------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------:| | ||
| <img width="173" alt="image" src="https://github.com/user-attachments/assets/488fec06-d15c-444b-a7ac-9b6f0c633839" /> | <img width="172" alt="image" src="https://github.com/user-attachments/assets/021ca13c-4e3c-4db8-aebb-5f920c3a6338" /> | <img width="164" alt="image" src="https://github.com/user-attachments/assets/6422ab4d-c39f-43e0-bb8c-e065dd2f4635" /> | <img width="164" alt="image" src="https://github.com/user-attachments/assets/180c4941-1370-482e-a626-21324fcf1ef9" /> | <img width="213" alt="image" src="https://github.com/user-attachments/assets/6ae5daf0-5ca5-4581-82c4-1cbc3eb78336" /> | | ||
| [dong99u](https://github.com/dong99u) | [jher235](https://github.com/jher235) | [seoshinehyo](https://github.com/seoshinehyo) | [so3659](https://github.com/so3659) | [yunseo02](https://github.com/yunseo02) | | ||
|
||
## Tech Stack | ||
|
||
<div align=center> | ||
|
||
### โ๏ธBack-end | ||
|
||
| ๊ธฐ์ ์คํ | ๋ฒ์ | | ||
|:---------------------------------------------------------------------------------------------------------------------:|:------:| | ||
| <img src="https://img.shields.io/badge/java-007396?style=for-the-badge&logo=OpenJDK&logoColor=white"> | 21 | | ||
|  | 3.3.5 | | ||
|  | 8.0.39 | | ||
|
||
<img src="https://img.shields.io/badge/ubuntu-E95420?style=for-the-badge&logo=ubuntu&logoColor=white"> | ||
<img src="https://img.shields.io/badge/python-3776AB?style=for-the-badge&logo=python&logoColor=white"> | ||
<img src="https://img.shields.io/badge/java-007396?style=for-the-badge&logo=OpenJDK&logoColor=white"> | ||
<img src="https://img.shields.io/badge/Spring-6DB33F?style=for-the-badge&logo=Spring&logoColor=white"> | ||
<img src="https://img.shields.io/badge/spring%20boot-6DB33F?style=for-the-badge&logo=springboot&logoColor=white"> | ||
<img src="https://img.shields.io/badge/spring%20security-6DB33F?style=for-the-badge&logo=SPRING%20SECURITY&logoColor=white"> | ||
<img src="https://img.shields.io/badge/mysql-4479A1?style=for-the-badge&logo=mysql&logoColor=white"> | ||
<img src="https://img.shields.io/badge/amazon%20aws-232F3E?style=for-the-badge&logo=amazonaws&logoColor=white"> | ||
<img src="https://img.shields.io/badge/terraform-844FBA?style=for-the-badge&logo=terraform&logoColor=white"> | ||
<img src="https://img.shields.io/badge/GitHub Actions-2088FF?style=for-the-badge&logo=GitHub Actions&logoColor=white"> | ||
<img src="https://img.shields.io/badge/docker-2496ED?style=for-the-badge&logo=docker&logoColor=white"> | ||
|
||
### โ๏ธFrond-end | ||
|
||
<img src="https://img.shields.io/badge/html5-E34F26?style=for-the-badge&logo=html5&logoColor=white"> | ||
<img src="https://img.shields.io/badge/css3-1572B6?style=for-the-badge&logo=css3&logoColor=white"> | ||
<img src="https://img.shields.io/badge/javascript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black"> | ||
<img src="https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white"> | ||
<img src="https://img.shields.io/badge/Next.js-000000?style=for-the-badge&logo=Next.js&logoColor=white"> | ||
|
||
</div> | ||
|
||
## ์ธํ๋ผ ์ํคํ ์ณ | ||
|
||
- 3 Tier Architecture๋ก AWS ์ธํ๋ผ ํ๊ฒฝ๊ตฌ์ฑ์ ์ค์ ํ์ต๋๋ค. | ||
- ์ํํธ์จ์ด ์์คํ ์ ์ฌ์ฉ์์ ์ธํฐํ์ด์ค๋ฅผ ์ฒ๋ฆฌํ๊ณ ํด๋ผ์ด์ธํธ์ ์ํธ์์ฉํ๋ ๊ณ์ธต, ๋น์ฆ๋์ค ๋ก์ง์ ์ฒ๋ฆฌํ๊ณ ์ ํ๋ฆฌ์ผ์ด์ ์ ํต์ฌ ๊ธฐ๋ฅ์ ์คํํ๋ ๊ณ์ธต, ๋ฐ์ดํฐ๋ฒ ์ด์ค ๋ฐ ๋ฐ์ดํฐ ์ ์ฅ์์ ์ํธ ์์ฉํ์ฌ ๋ฐ์ดํฐ๋ฅผ ์ ์ฅํ๊ณ ๊ฒ์ํ๋ ์ธ ๊ฐ์ง ์ฃผ์ ๊ณ์ธต์ผ๋ก ๋๋ด์ต๋๋ค. | ||
- ์ด๋ฅผ ํตํด ๊ฐ ๊ณ์ธต์ ๋ ๋ฆฝ์ ์ผ๋ก ๊ฐ๋ฐ ๋ฐ ์ ์ง๋ณด์ํ ์ ์์ผ๋ฏ๋ก ์ฝ๋์ ๋ชจ๋ํ๊ฐ ์ฝ๊ณ , ๋น์ฆ๋์ค ๋ก์ง์ ๋น์ฆ๋์ค ๊ณ์ธต ์ค์ ์ ์ผ๋ก ๊ตฌํ๋๋ฏ๋ก, ํด๋น ๋ก์ง์ ๋ค๋ฅธ ํด๋ผ์ด์ธํธ๋ ์ ํ๋ฆฌ์ผ์ด์ ์์ ์ฌ์ฌ์ฉํ ์ ์์์ต๋๋ค. | ||
|
||
 | ||
|
||
## ์์คํ ๊ตฌ์ฑ๋ | ||
|
||
- Github์ actions ๊ธฐ๋ฅ์ ํ์ฉํ์ฌ ๊ฐ๋ฐ์๊ฐ release ๋ธ๋์น๋ก feature ํ๋ก์ ํธ๋ฅผ mergeํ๋ ์๊ฐ ํธ๋ฆฌ๊ฑฐ๊ฐ ๋ฐ๋๋์ด ํ๋ก์ ํธ์ ๋ฒ์ ์ ์ ๋ฐ์ดํธ ํ ์ ์๋๋ก ๊ตฌ์ฑํ์ต๋๋ค. | ||
- Github actions์์ buildํ docker image๋ค์ docker hub๋ก push ๋ฉ๋๋ค. ์ดํ actions์์ ์๋ฒ ์ธก์ผ๋ก ์ง์ ์ ํ๊ฒ ๋๊ณ , ํด๋น ์๋ฒ์์ docker hub์ ์๋ ์ด๋ฏธ์ง๋ค์ pull ๋ฐ์ ํ์ฌ ์คํ์ค์ธ ์ดํ๋ฆฌ์ผ์ด์ ์ ๋ค์ดํ๊ณ ์๋ก pull ๋ฐ์ ์ด๋ฏธ์ง๋ค์ ์ดํ๋ฆฌ์ผ์ด์ ์ผ๋ก up ํฉ๋๋ค. | ||
 | ||
|
||
## ํ์ ๊ท์น | ||
|
||
### Github ํ์ ๊ท์น | ||
|
@@ -111,22 +72,25 @@ Github ํ์ ๊ท์น์ ์๋์ ๊ฐ์ต๋๋ค. | |
|
||
| ์ปค๋ฐ ํ์ | ์ค๋ช | | ||
| --------- | -------------------------------------------------------------- | | ||
| Feat | ์๋ก์ด ๊ธฐ๋ฅ ์ถ๊ฐ | | ||
| Fix | ๋ฒ๊ทธ ์์ | | ||
| Docs | ๋ฌธ์ ์์ | | ||
| Style | ์ฝ๋ formatting, ์ธ๋ฏธ์ฝ๋ก ๋๋ฝ ๋ฑ ์ฝ๋ ์์ฒด์ ๋ณ๊ฒฝ์ด ์๋ ๊ฒฝ์ฐ | | ||
| Chore | ํจํค์ง ๋งค๋์ ์์ ๋ฐ ๊ธฐํ ์์ | | ||
| Design | CSS ๋ฑ ์ฌ์ฉ์ UI ๋ณ๊ฒฝ | | ||
| feature | ์๋ก์ด ๊ธฐ๋ฅ ๊ตฌํ | | ||
| fix | ์์ | | ||
| refactor | ๋ฆฌํฉํ ๋ง | | ||
| docs | ๋ฌธ์ ์์ | | ||
| style | ์ฝ๋ ํฌ๋งทํ , ์ธ๋ฏธ์ฝ๋ก ๋๋ฝ, ์ฝ๋ ๋ณ๊ฒฝ์ด ์๋ ๊ฒฝ์ฐ | | ||
| chore | ํจํค์ง ๊ตฌ์กฐ ์์ , code์ ๋ฌด๊ดํ ๋ถ๋ถ๋ค (.gitignore, build.gradle ๊ฐ์) ์์ | | ||
| hotfix | hotfix | | ||
| remove | ํจํค์ง๋ ํด๋์ค ์ญ์ | | ||
| test | ํ ์คํธ ์ฝ๋, ๋ฆฌํํ ๋ง ํ ์คํธ ์ฝ๋ ์ถ๊ฐ | | ||
| rename | ํจํค์ง๋ ํด๋์ค๋ช ์์ | | ||
| comment | ์ฃผ์ ์ถ๊ฐ | | ||
|
||
### Issue ํ์ฉ | ||
|
||
 | ||
 | ||
|
||
- Github ๋ ํฌ์งํ ๋ฆฌ์ Issueํญ์ Todo์ธ ์ํฉ ํน์ In progress์ ๋ํ ์ํฉ์ ์์ฑํ๊ณ ๊ณต์ ํ์ต๋๋ค. ํด๋น Issue ๋ฒํธ๋ก ๊ฐ์์ ๋ก์ปฌ ๋ ํฌ์งํ ๋ฆฌ์ ๋ธ๋์น๋ฅผ ์์ฑํ์ฌ Pull Request ์์ ํด๋น Issue๋ฅผ ์ธ๊ธํ์ฌ ๊ณต์ ํ์ต๋๋ค. ํด๋น ์ ๋ต์ ์ฌ์ฉํ์ฌ Merge Conflict์ ๋ฐ์ ๊ฐ๋ฅ์ฑ์ ์ค์์ต๋๋ค. | ||
|
||
### PR ํ์ฉ | ||
|
||
 | ||
 | ||
|
||
- ๋ค์๊ณผ ๊ฐ์ด ๊ฐ๋ฐ ์ดํ ํน์ ํ๋ก์ ํธ์ ๋ํ ๋ณ๊ฒฝ์ฌํญ์ ์ ์ํ๊ณ , ํ์๊ณผ ์ด๋ฅผ ๊ฒํ ๋ฐ ๋ ผ์ํ ํ, ์ต์ข ์ ์ผ๋ก ํด๋น ๋ณ๊ฒฝ์ฌํญ์ ๋ฐ์ํ ์ ์๋๋ก ํ์ต๋๋ค. | ||
- ๋ค๋ฅธ ๊ฐ๋ฐ์๋ค์ ํด๋น Pull Request๋ฅผ ๊ฒํ ํ๊ณ , ํ์ํ ๊ฒฝ์ฐ ํผ๋๋ฐฑ์ ์ ๊ณตํ ์ ์์์ต๋๋ค. | ||
|
@@ -136,55 +100,40 @@ Github ํ์ ๊ท์น์ ์๋์ ๊ฐ์ต๋๋ค. | |
|
||
<div align=center> | ||
|
||
<p>๋ก๊ทธ์ธ / ํ์๊ฐ์ </p> | ||
<h3>๋ก๊ทธ์ธ / ํ์๊ฐ์ </h3> | ||
|
||
 | ||
 | ||
 | ||
 | ||
 | ||
 | ||
|
||
|
||
<h3>์ฒดํ ๋ถ์</h3> | ||
|
||
 | ||
 | ||
|
||
<p>์ฒดํ ๋ถ์</p> | ||
<h3>์คํ์ผ ์ถ์ฒ</h3> | ||
|
||
 | ||
 | ||
<p>์คํ์ผ ์ถ์ฒ</p> | ||
|
||
 | ||
 | ||
<p>ํจ์ ์์ดํ ์ถ์ฒ</p> | ||
|
||
 | ||
 | ||
|
||
<p>๋ง์ดํ์ด์ง</p> | ||
<h3>๋ง์ดํ์ด์ง</h3> | ||
<img width="986" alt="Image" src="https://github.com/user-attachments/assets/bdd28c2d-bd05-4e38-b8fd-c1b25a443d2e" /> | ||
<img width="1192" alt="Image" src="https://github.com/user-attachments/assets/e248157a-cee7-4d5f-8bde-ccf882a2a3e6" /> | ||
<img width="583" alt="Image" src="https://github.com/user-attachments/assets/a2d362ca-4994-415c-a67c-59d45797045a" /> | ||
<img width="785" alt="Image" src="https://github.com/user-attachments/assets/28089422-9155-4d36-a9d2-449c818eb985" /> | ||
|
||
|
||
<p>๋น์ทํ ์ฒดํ ๊ฒ์๊ธ</p> | ||
<h3>๋น์ทํ ์ฒดํ ๊ฒ์๊ธ</h3> | ||
<img width="994" alt="Image" src="https://github.com/user-attachments/assets/7e08d1a3-5ae5-4799-b740-17dc50ea40de" /> | ||
<img width="486" alt="Image" src="https://github.com/user-attachments/assets/59560e91-9ef8-42b8-a057-28fbfa49ac03" /> | ||
|
||
|
||
</div> | ||
|
||
## ๊ธฐ๋ํจ๊ณผ | ||
|
||
๊ธฐ๋ํจ๊ณผ๋ ์๋์ ๊ฐ์ต๋๋ค. | ||
|
||
1. ํ์ด์ง ํ๋์ ํ์๋ค์ด ์ฌ์ฉํ๋ ๋๋ถ๋ถ์ ๊ธฐ๋ฅ์ด ํตํฉ ๋์ด์์ด ์ฌ์ฉ์์ ํธ์์ฑ ์ฆ์ง | ||
2. PC, ๋ชจ๋ฐ์ผ ํ๊ฒฝ์ ๋ชจ๋ ๊ณ ๋ คํ ๊ฐ์ ์ ํตํด ์ฌ์ฉ์์ ํธ์์ฑ ์ฆ์ง | ||
3. ํ๋ก์ ํธ ์ํ์ ํตํ ํ์๋ค์ ์น ์์คํ ๊ตฌ์กฐ ์ดํด ์์น | ||
4. ํ์ ํด (Github, Notion, Slack)์ ํ์ฉํ์ฌ ํ์๋ค์ ์ปค๋ฎค๋์ผ์ด์ ๋ฅ๋ ฅ ํฅ์ | ||
5. ์คํ์์ค๋ฅผ ํตํด ๊ฐ๋ฐํ๋ ๊ณผ์ ์ ๋ํ ์ดํด ์์น | ||
|
||
## License | ||
Distributed under the MIT License. See `LICENSE.txt` for more information. | ||
|
||
## Contact | ||
|
||
* ๋ฐ๋๊ท : [email protected] | ||
|