An open API service indexing awesome lists of open source software.

https://github.com/codestates-seb/seb43_main_027


https://github.com/codestates-seb/seb43_main_027

Last synced: about 1 year ago
JSON representation

Awesome Lists containing this project

README

          

## ๐Ÿ’ป Code Jejus







* Team Nameย :ย Code Jejus
* Durationย :ย 2023.04.28 - 2023.05.25
* Project Nameย :ย InddyBuddy
* ์ธ๋””๋ฒ„๋””๋Š” ์ธ๋”” ๊ฒŒ์ž„ ์ปค๋ฎค๋‹ˆํ‹ฐ ์›น ์‚ฌ์ดํŠธ๋กœ, ํŠน์ • ๊ฒŒ์ž„์— ๋Œ€ํ•œ ์ปค๋ฎค๋‹ˆํ‹ฐ๋ฅผ ์ƒ์„ฑํ•˜๊ณ  ๋‹ค๋ฅธ ์œ ์ €๋“ค๊ณผ ์†Œํ†ตํ•  ์ˆ˜ ์žˆ๋Š” ํ”Œ๋žซํผ์ž…๋‹ˆ๋‹ค.
* ์œ ์ €๋“ค์€ ๋‹ค์–‘ํ•œ ์ธ๋”” ๊ฒŒ์ž„์„ ์‰ฝ๊ฒŒ ์ ‘ํ•  ์ˆ˜ ์žˆ์œผ๋ฉฐ, ์ปค๋ฎค๋‹ˆํ‹ฐ๋ฅผ ํ†ตํ•ด ๋‹ค๋ฅธ ์œ ์ €๋“ค๊ณผ ์—ฐ๊ฒฐ๋˜์–ด ๊ฒŒ์ž„์„ ์ฆ๊ธธ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

## ๐Ÿ“Ž ๋ฐ”๋กœ๊ฐ€๊ธฐ
- โ–ถ๏ธ [๋ฐฐํฌ ๋งํฌ ๋ฐ”๋กœ๊ฐ€๊ธฐ](http://inddy-buddy.s3-website.ap-northeast-2.amazonaws.com/)
- ๐ŸŽ† [ํŒ€ ๋…ธ์…˜ ํŽ˜์ด์ง€ ๋ฐ”๋กœ๊ฐ€๊ธฐ](https://wirehaired-beret-069.notion.site/db95b27bc19e490caf7f534abcbaf34a?v=c152bce705ab42e2842870a7179b2901)
- ๐Ÿ–ฅ [Github Repository ๋ฐ”๋กœ๊ฐ€๊ธฐ](https://github.com/codestates-seb/seb43_main_027)

## ๐Ÿ’ป Stacks Used
### Back-end
| Java | Spring | Spring Boot | Spring Security | MySQL | AWS | JWT |
| :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: |:----------------------------------------------------------: |
|

icon
| spring logo | spring-boot logo | spring-security logo |
icon
|
icon
|
icon
|

### Front-end
| Html | CSS | JavaScript | React | Styled
Components | axios | esLint | Figma | React
Router | typescript | redux |
| :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: |:----------------------------------------------------------: | :----------------------------------------------------------: |
| Html |

CSS
|
icon
|
icon
|
styled-components icon
|
|
|
|
|
|
|

### Tools
| Github | Discord | Notion |
| :--------: | :--------: | :------: |
| github logo | Discord logo | Notion logo |

## ๐Ÿง‘โ€๐Ÿคโ€๐Ÿง‘ Team members
| ์ด์—ฐ์ˆ˜
(Be Leader) | ์šฐ์„ฑ์ผ
(BE) | ๋ฐ•ํ˜ธ์ œ
(BE) |
|:--------:| :--------: | :--------: |
| ์ด์—ฐ์ˆ˜| ์šฐ์„ฑ์ผ | ๋ฐ•ํ˜ธ์ œ |
|[@yeonssu](https://github.com/yeonssu) | [@wooniverse7](https://github.com/wooniverse7) | [@zini9188](https://github.com/zini9188) |
|


- ์นดํ…Œ๊ณ ๋ฆฌ ๊ด€๋ จ ๊ธฐ๋Šฅ ๊ตฌํ˜„
- ๊ฒŒ์ž„ ๊ด€๋ จ ๊ธฐ๋Šฅ ๊ตฌํ˜„
- ๋ถ๋งˆํฌ ๊ธฐ๋Šฅ ๊ตฌํ˜„
- ์ฒจ๋ถ€ํŒŒ์ผ AWS S3 ์—…๋กœ๋“œ
- AWS ์ž๋™ํ™” ๋ฐฐํฌ |

- ๊ฒŒ์‹œ๊ธ€ ๊ด€๋ จ ๊ธฐ๋Šฅ ๊ตฌํ˜„
- ๋Œ“๊ธ€ ๊ด€๋ จ ๊ธฐ๋Šฅ ๊ตฌํ˜„
- ๋Œ“๊ธ€ ๊ธฐ๋Šฅ ๊ณ ๋„ํ™” (๋Œ€๋Œ“๊ธ€) |

- ๊ฒŒ์ž„ ํŒ”๋กœ์šฐ ๊ธฐ๋Šฅ ๊ตฌํ˜„
- ํšŒ์› ํŒ”๋กœ์šฐ ๊ธฐ๋Šฅ ๊ตฌํ˜„
- oauth ๊ธฐ๋Šฅ ๊ตฌํ˜„
- jwt ๊ธฐ๋Šฅ ๊ตฌํ˜„
- ํšŒ์› ๊ด€๋ จ ๊ธฐ๋Šฅ ๊ตฌํ˜„
- ๋ฉ”์‹œ์ง€ ๊ธฐ๋Šฅ ๊ตฌํ˜„
- AWS ์ž๋™ํ™” ๋ฐฐํฌ |

| ๊น€์ง„์™„
(FE Leader) | ์ •์šฐ์„ 
(FE) | ํ•œ์ˆ˜์ง€
(FE) |
| :--------: | :--------: | :--------: |
| ๊น€์ง„์™„ | ์ •์šฐ์„  | ํ•œ์ˆ˜์ง€ |
| [@crowwan](https://github.com/crowwan) | [@UseonJ](https://github.com/UseonJ) | [@nincoding](https://github.com/nincoding) |
|

- ๊ฒŒ์‹œ๊ธ€ crud
- ๋Œ“๊ธ€ ๋ฐ ๋Œ€๋Œ“๊ธ€ crud
- ๊ฒŒ์‹œ๊ธ€ ์ข‹์•„์š” ๋ฐ ๋ถ๋งˆํฌ ๊ธฐ๋Šฅ
- ์ฑ„ํŒ… ๊ธฐ๋Šฅ
- ๋„ค๋น„๊ฒŒ์ด์…˜๋ฐ” ui ๊ตฌํ˜„ ๋ฐ ๊ธฐ๋Šฅ
- ํ™ˆ ํ™”๋ฉด ํŽ˜์ด์ง€๋„ค์ด์…˜|

- ํšŒ์›๊ฐ€์ž…/๋กœ๊ทธ์ธ ํŽ˜์ด์ง€
- ๊ฒŒ์ž„๋“ฑ๋ก CRUD
- ๊ฒŒ์ž„๋“ฑ๋ก ํŽ˜์ด์ง€ UI/๊ธฐ๋Šฅ ๊ตฌํ˜„
- ๊ฒ€์ƒ‰๊ฒฐ๊ณผ ํŽ˜์ด์ง€ UI/๊ธฐ๋Šฅ ๊ตฌํ˜„|

- ์นดํ…Œ๊ณ ๋ฆฌ๋ณ„ ๊ฒŒ์ž„ UI ๋ฐ ์กฐํšŒ R
- ์ƒ์„ธ ๊ฒŒ์ž„ ๊ด€๋ จ UI ๋ฐ ์กฐํšŒ R
- ์ƒ์„ธ ํšŒ์› ํŽ˜์ด์ง€ UI ๋ฐ ๊ธฐ๋Šฅ ๊ตฌํ˜„ R
- ํšŒ์›์ •๋ณด ์ˆ˜์ • ๋ฐ ํšŒ์› ํƒˆํ‡ด ๊ธฐ๋Šฅ UD
- ๊ฒŒ์ž„,์œ ์ € ํŒ”๋กœ์šฐ ๋ฐ ์–ธํŒ”๋กœ์šฐ ๊ธฐ๋Šฅ U|

## ๐Ÿ“Œ Introduction to Project Features

### ํšŒ์› ๊ธฐ๋Šฅ
- ํšŒ์›๊ฐ€์ž…(์ธ์ฆ์ฝ”๋“œ ๋ฉ”์ผ)
userflow
- ๋กœ๊ทธ์ธ
userflow
- ๋กœ๊ทธ์•„์›ƒ
userflow
- ํšŒ์› ์ •๋ณด ์กฐํšŒ (๋งˆ์ดํŽ˜์ด์ง€/ํƒ€์œ ์ €ํŽ˜์ด์ง€)
userflow
- ํšŒ์› ์ •๋ณด ์ˆ˜์ •
userflow
- ๋น„๋ฐ€๋ฒˆํ˜ธ ๋ณ€๊ฒฝ
userflow
- ํšŒ์› ์ •๋ณด ์‚ญ์ œ
userflow

### ๋ฉ”์ธ ๊ธฐ๋Šฅ
- ์นดํ…Œ๊ณ ๋ฆฌ ํŽ˜์ด์ง€(๋ฉ”์ธ ํ™”๋ฉด)
userflow
- ๊ฒŒ์ž„ ํŽ˜์ด์ง€
userflow
- ๊ฒŒ์ž„ ๋“ฑ๋ก
userflow

### ๊ฒŒ์‹œ๊ธ€ ๊ธฐ๋Šฅ
- ๊ฒŒ์‹œ๊ธ€ ๋Œ“๊ธ€(๋Œ€๋Œ“๊ธ€) ์ž‘์„ฑ, ์ข‹์•„์š”, ๋ถ๋งˆํฌ ๊ธฐ๋Šฅ
userflow
- ๊ฒŒ์‹œ๊ธ€ ์ž‘์„ฑ
userflow

### ํŒ”๋กœ์šฐ ๊ธฐ๋Šฅ
- ์œ ์ € ํŒ”๋กœ์šฐ
userflow
- ๊ฒŒ์ž„ ํŒ”๋กœ์šฐ
userflow

### ๊ฒ€์ƒ‰ ๊ธฐ๋Šฅ
- ์œ ์ €, ๊ฒŒ์ž„, ๊ฒŒ์‹œ๊ธ€ ๊ฒ€์ƒ‰
userflow

### ๋ฉ”์‹œ์ง€(์ฑ„ํŒ…) ๊ธฐ๋Šฅ
- ๋ฉ”์‹œ์ง€ ์ „์†ก ๋ฐ ํ™•์ธ
userflow

### ์•Œ๋ฆผ ๊ธฐ๋Šฅ
- ๋ฉ”์‹œ์ง€, ๋Œ“๊ธ€, ๋Œ€๋Œ“๊ธ€, ์ข‹์•„์š”, ํŒ”๋กœ์šฐ ์‹œ ์•Œ๋ฆผ

## ๐Ÿ”– Project Docs

### ์‚ฌ์šฉ์ž ์š”๊ตฌ์‚ฌํ•ญ ์ •์˜์„œ
requirement
requirement
requirement
requirement

### DB Diagram
schema

### Figma
[Wireframe Link (Figma)](https://www.figma.com/file/VzRAgvf5oXx476ylKOchHV/inddy-buddy?type=design&node-id=0-1&t=EqD0LKzE2oIl77L1-0)

## ๐Ÿ“ข Github Rule

### Commit Convention

| Message | ์„ค๋ช… |
| :--------: | :---------------------------------------------------- |
| `add` | ์ƒˆ๋กœ์šด ํ”„๋กœ์ ํŠธ, ํŒŒ์ผ ๋“ฑ ์ถ”๊ฐ€ |
| `feat` | ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€ |
| `fix` | ๋ฒ„๊ทธ ์ˆ˜์ • |
| `refactor` | ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง |
| `style` | ์ฝ”๋“œ ํฌ๋งทํŒ…, ์„ธ๋ฏธ์ฝœ๋ก  ๋ˆ„๋ฝ, ์ฝ”๋“œ ์Šคํƒ€์ผ ๋ณ€๊ฒฝ ๋“ฑ |
| `remove` | ์‚ฌ์šฉํ•˜์ง€ ์•Š๋Š” ํŒŒ์ผ ๋˜๋Š” ํด๋” ์‚ญ์ œ |
| `rename` | ํŒŒ์ผ ๋˜๋Š” ํด๋”๋ช… ์ˆ˜์ • |
| `chore` | ๋นŒ๋“œ ์—…๋ฌด ์ˆ˜์ •, ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ € ์ˆ˜์ • |

### Branch

- `main` : ์„œ๋น„์Šค ์šด์˜ ๋ธŒ๋žœ์น˜
- `dev` : ๋ฉ”์ธ ๋ธŒ๋žœ์น˜ ๋ฐฐํฌ์ „ ๋ฆด๋ฆฌ์ฆˆ ๋ธŒ๋žœ์น˜
- `be-dev` : BE ๊ฐœ๋ฐœ ํ™˜๊ฒฝ ๋ธŒ๋žœ์น˜
- `fe-dev` : FE ๊ฐœ๋ฐœ ํ™˜๊ฒฝ ๋ธŒ๋žœ์น˜
- `be-feat/[feature name]` : BE ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ ๋ธŒ๋žœ์น˜
- `fe-feat/[feature name]` : FE ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ ๋ธŒ๋žœ์น˜