https://github.com/codestates-seb/seb43_main_007
๐ณ ๋๋ง์ ์นํ๊ฒฝ - ์นํ๊ฒฝ ์ํ ์ค์ฒ์ ๊ณต์ ํ๊ณ ๊ณต๊ฐํ๋ ์ฐ๋ฆฌ๋ค์ ๊ณต๊ฐ
https://github.com/codestates-seb/seb43_main_007
Last synced: 9 months ago
JSON representation
๐ณ ๋๋ง์ ์นํ๊ฒฝ - ์นํ๊ฒฝ ์ํ ์ค์ฒ์ ๊ณต์ ํ๊ณ ๊ณต๊ฐํ๋ ์ฐ๋ฆฌ๋ค์ ๊ณต๊ฐ
- Host: GitHub
- URL: https://github.com/codestates-seb/seb43_main_007
- Owner: codestates-seb
- Created: 2023-04-28T01:27:10.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-09T09:52:00.000Z (almost 3 years ago)
- Last Synced: 2025-04-13T01:44:34.735Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 31.8 MB
- Stars: 6
- Watchers: 2
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ๐ ๋ฉ์ธํ์คํ ๋ฆฌ
### ๋๋ง์ ์นํ๊ฒฝ ์ปค๋ฎค๋ํฐ
ํ๋ก์ ํธ๋ช
: ๋๋ง์ ์นํ๊ฒฝ
ํ๋ก์ ํธ ์๊ฐ : ์นํ๊ฒฝ ์ํ ์ค์ฒ์ ๊ณต์ ํ๊ณ ๊ณต๊ฐํ๋ ์ฐ๋ฆฌ๋ค์ ์ปค๋ฎค๋ํฐ
ํ๋ก์ ํธ ๊ธฐ๊ฐ : 2023.05.01 - 2023.05.26
๋ฐฐํฌ๋งํฌ: http://ourecostory.s3-website.ap-northeast-2.amazonaws.com/
## ๐งโ๐คโ๐ง Team members
| ์ฃผํจ์ง
(FE Leader) | ์ด์ธ์
(FE) | ๊น์ํ
(FE) | ์ฒ์ฐฌ์
(BE Leader) | ๊น์ค์ง
(BE) | ์ด์ธ๊ฑด
(BE) |
|:--------:| :--------: | :--------: | :--------: | :--------: | :--------: |
|
|
|
|
|
|
|
|[@HJNJu](https://github.com/HJNJu) | [@LEE2302](https://github.com/LEE2302) | [@kimsh322](https://github.com/kimsh322) | [@ccw7016](https://github.com/ccw7016) | [@jungdi3333](https://github.com/jungdi3333) | [@ingeon2](https://github.com/ingeon2) |
## ๐ป Tech Stack
### ๐
Front-end

### ๐ Back-end
### ๐ Server

## โ Project Architecture

## ๐ฅ๏ธ Demo
|ํ์๊ฐ์
|๋ก๊ทธ์ธ|์์ด๋/๋น๋ฐ๋ฒํธ ์ฐพ๊ธฐ|
| :---: | :---: | :---: |
|
|
|
|
|<ํ์๊ฐ์
ํ์ด์ง>
- ์ฌ๋ฌ ์ ๋ณด๋ค์ ์
๋ ฅํ๊ณ ํ์๊ฐ์
ํ ์ ์๋ค.
- ์ด๋ฏธ ๊ฐ์
๋์ด ์๋ ์ด๋ฉ์ผ๊ณผ ๋๋ค์์ ํ์ ๊ฐ์
์ด ๋ถ๊ฐ๋ฅํ๋ค.
- ๊ฐ ์
๋ ฅ์ฐฝ๋ง๋ค ์ ํจ์ฑ ๊ฒ์ฌ๊ฐ ์กด์ฌํ๋ค.
-๊ฐ์
์ฑ๊ณต ์ ๋ก๊ทธ์ธ ํ๋ฉด์ผ๋ก ์ด๋ํ๋ค.
|<๋ก๊ทธ์ธ ํ์ด์ง>
-์ด๋ฉ์ผ ์ฃผ์, ๋น๋ฐ๋ฒํธ๋ฅผ ์
๋ ฅํ์ฌ ๋ก๊ทธ์ธ ํ ์ ์๋ค.
-Google Oauth ๋ก๊ทธ์ธ ๊ฐ๋ฅํ๋ค.
-๋ก๊ทธ์ธ ์ฑ๊ณต ์ ํ ํ๋ฉด์ผ๋ก ์ด๋ํ๋ค.
|<์์ด๋/๋น๋ฐ๋ฒํธ ์ฐพ๊ธฐ>
- ํ์๊ฐ์
ํ ๋ ์
๋ ฅํ ์ฃผ๋ฏผ๋ฑ๋ก๋ฒํธ๋ก ์์ ์ ์์ด๋๋ฅผ ์ฐพ์ ์ ์๋ค.
- ์์ด๋์ ํ์๊ฐ์
ํ ๋ ์
๋ ฅํ ๋น๋ฐ๋ฒํธ ์ฐพ๊ธฐ ์ง๋ฌธ/๋ต๋ณ์ ์
๋ ฅํ๋ฉด ์์๋น๋ฐ๋ฒํธ๋ฅผ ๋ฐ๊ธ๋ฐ์ ์ ์๋ค.
|ํ/๋๋น๊ฒ์ด์
๋ฐ|๊ฒ์๊ธ ๋ชฉ๋ก|๊ฒ์๊ธ ์์ธ|
|
|
|
|
|<ํ>
- ๊ด๋ฆฌ์ ์ฑํ๊ธ์ ์บ๋ฌ์
ํํ๋ก ๋ณผ ์ ์๋ค. ์บ๋ฌ์
์ ํ์ดํ ๋ฒํผ์ผ๋ก ์ด๋๊ฐ๋ฅํ๋ค.
๊ด๋ฆฌ์ ์ฑํ๊ธ์์๋ ๊ฒ์๊ธ์ ์์ฑํ ๋ ์
๋ ฅํ ์ฃผ์๊ฐ ์นด์นด์ค๋งต์ผ๋ก ํ์๋๋ค.
<๋๋น๊ฒ์ด์
๋ฐ>
- ๋น๋ก๊ทธ์ธ ์ ๋ก๊ทธ์ธ ๋ฒํผ์ด ๋ณด์ด๋ฉฐ ํด๋ฆญ ์ ๋ก๊ทธ์ธ ํ๋ฉด์ผ๋ก ์ด๋ํ๋ค.
- ๋ก๊ทธ์ธ ์ ๋ก๊ทธ์ธ ๋ฒํผ์ด ํ๋กํ๋ก ๋ณ๊ฒฝ๋๋ฉฐ ํด๋ฆญ ์ ๋ง์ดํ์ด์ง๋ก ์ด๋ํ๋ค.
- ์์ธ์ ๋ฏธ์ธ๋จผ์ง ์ํฉ์ ์๋ ค์ฃผ๋ฉฐ, ์ข์, ๋ณดํต, ๋์จ์ผ๋ก ๋๋ ์ด๋ชจํฐ์ฝ๊ณผ ์์์ด ๋ณ๊ฒฝ๋๋ค.
- ์นดํ
๊ณ ๋ฆฌ ํด๋ฆญ ์ ํด๋น ์นดํ
๊ณ ๋ฆฌ ๊ฒ์๊ธ ๋ชฉ๋ก ํ์ด์ง๋ก ์ด๋ํ๋ค.
- ํ์ฌ ์ด๋ค ์นดํ
๊ณ ๋ฆฌ๊ฐ ํด๋ฆญ๋์๋์ง ํ์๋๋ค.|๊ฒ์๊ธ ๋ชฉ๋ก
- ์นดํ
๊ณ ๋ฆฌ๋ณ ๊ฒ์๊ธ ๋ชฉ๋ก์ ๋์ดํ๋ค.
- ๊ฒ์๊ธ ํด๋ฆญ์ ์์ธํ์ด์ง๋ก ์ด๋ํ๋ค.
- ๊ฒ์๊ธ ์ข์์์ ๋ถ๋งํฌ๋ฅผ ํด๋ฆญ์ ์์์ด ๋ณํ๋ค.
- ํ์ด์ง๋ค์ด์
์ผ๋ก ํ์ด์ง ์ด๋์ด ๊ฐ๋ฅํ๋ค.
- ๊ฒ์์ ์ ๋ชฉ,๋ด์ฉ,ํ๊ทธ๋ก ๊ฒ์์ด ๊ฐ๋ฅํ๋ค.
- ๊ธ์ฐ๊ธฐ ํด๋ฆญ์ ๊ธ์ฐ๊ธฐ ์์ฑํ์ด์ง๋ก ์ด๋ํ๋ค.|<๊ฒ์๊ธ ๋ด์ฉ>
- ๊ฒ์๊ธ ์ ๋ชฉ, ์์ฑ์ ํ๋กํ ์ฌ์ง ๋ฐ ๋๋ค์, ์์ฑ ๋ ์ง, ์ด ์ข์์ ๊ฐ์์ ๋๊ธ ๊ฐ์, ์ฃผ์, ๋ด์ฉ, ์ฌ์ง, ํ๊ทธ, ๋๊ธ ๋๋๊ธ์ ๋ณด์ฌ์ค๋ค.
- ์ผ๋ฐ ์ ์ ์ ๊ฒฝ์ฐ ์ข์์์ ๋ถ๋งํฌ ๋ฒํผ, ๊ด๋ฆฌ์์ ๊ฒฝ์ฐ ์ฑํ๊ณผ ๊ณ ์ ๋ฒํผ์ด ๋ณด์ธ๋ค.
- ์์ฑ์์ ๊ฒฝ์ฐ ์์ ๋ฐ ์ญ์ ๋ฒํผ์ด ๋ณด์ธ๋ค.
<๋๊ธ ๋ฐ ๋๋๊ธ>
- ์
๋ ฅ์ฐฝ์๋ 300์ ์ด๊ณผ ์ ๋์ด์ ์
๋ ฅ๋์ง ์์ผ๋ฉฐ ๋ฑ๋ก ๋ฒํผ์ ๋๋ฅด๋ฉด ๋๊ธ์ด ์์ฑ๋๋ค.
- ๋๊ธ์๋ ๋๊ธ ์ถ๊ฐ ๋ฒํผ์ด ์์ผ๋ฉฐ, ํด๋ฆญ ์ ํด๋น ๋๊ธ ์๋๋ก ๋๋๊ธ ์
๋ ฅ์ฐฝ์ด ๋ฌ๋ค.
- ์์ฑ์์ ๊ฒฝ์ฐ ๋๊ธ ์์ ๋ฐ ์ญ์ ๋ฒํผ์ด ๋ณด์ธ๋ค.
|
|๊ฒ์๊ธ ์์ฑ|๊ฒ์๊ธ ์์ |์ฑํ ๊ฒ์๊ธ ์์ |
|
|
|
|๊ฒ์๊ธ ์์ฑ
- ์ปค๋ฎค๋ํฐ, ์ ๋ชฉ, ์ฃผ์, ํ๊ทธ, ๋ณธ๋ฌธ์ ์์ฑํ ์ ์๋ค.
- text์๋ํฐ๋ฅผ ์ฌ์ฉํ์ฌ ๊ธ ์คํ์ผ๊ณผ ์ด๋ฏธ์ง๋ฅผ ์ฒจ๋ถํ ์ ์๋ค.
- ๋ฑ๋ก ํด๋ฆญ์ ์ ํจ์ฑ ๊ฒ์ฌ๋ฅผ ํ์ฌ ํต๊ณผํ๋ฉด ๊ธ ์์ฑ์ด ์๋ฃ๋๋ค.| - ๊ธฐ์กด ์์ฑ๋ ์นดํ
๊ณ ๋ฆฌ, ๊ฒ์๊ธ ์ ๋ชฉ, ์ฃผ์, ํ๊ทธ, ๋ด์ฉ, ์ฌ์ง ์ ๋ณด๊ฐ ๋์ด์จ๋ค.
- ์์ ๋ฒํผ ํด๋ฆญ ์ ์์ ๋ ๊ฒ์๊ธ ํ์ด์ง๋ก ์ด๋ํ๋ค.
| - ๊ธฐ์กด ์์ฑ๋ ์นดํ
๊ณ ๋ฆฌ, ๊ฒ์๊ธ ์ ๋ชฉ, ์ฃผ์, ํ๊ทธ, ๋ด์ฉ, ์ฌ์ง ์ ๋ณด๊ฐ ๋์ด์จ๋ค.
- ์ฑํ ๋ฒํผ ํด๋ฆญ ์ ํ์ผ๋ก ์ด๋๋๋ฉฐ ํด๋น ๊ฒ์๊ธ์๋ ์ฑํ ๋งํฌ๊ฐ ๋ถ๋๋ค.
|
|ํ์์ ๋ณด์์ |๋ถ๋งํฌ|๋ด๊ฐ ์ด ๊ธ|
|
|
|
|
|<๋๋ค์ ๋ณ๊ฒฝ>
- ๋๋ค์ ์ ํจ์ฑ ๊ฒ์ฌ ํต๊ณผ ์ ์ ์ฅ ๋ฒํผ์ด ํ์ฑํ๋๋ค.
- ๋๋ค์ ์ค๋ณต ์ ๋ณ๊ฒฝ ์คํจ ์๋ฆผ์ด ๋ฌ๋ค.
<ํ๋กํ ์ฌ์ง ๋ณ๊ฒฝ>
- JPG, PNG 1MB ๋ฏธ๋ง ํ์ผ ์
๋ก๋ ์ ํ๋กํ ์ฌ์ง์ด ๋ณ๊ฒฝ๋๋ค
- ์ญ์ ๋ฒํผ ํด๋ฆญ ์ ๊ธฐ๋ณธ ํ๋กํ ์ฌ์ง์ผ๋ก ๋ณ๊ฒฝ๋๋ค.
<๋น๋ฐ๋ฒํธ ๋ณ๊ฒฝ>
- ์๋ก์ด ๋น๋ฐ๋ฒํธ ์ ํจ์ฑ ๊ฒ์ฌ ๋ฐ ์ฌ์
๋ ฅ์ด ์ผ์นํ ๊ฒฝ์ฐ ๋ณ๊ฒฝ๋ฒํผ์ด ํ์ฑํ๋๋ค.
- ํ์ฌ ๋น๋ฐ๋ฒํธ๊ฐ ์ผ์นํ์ง ์์ ์ ๋ณ๊ฒฝ ์คํจ ์๋ฆผ์ด ๋ฌ๋ค.
<๊ณ์ ์ญ์ >
- ๊ณ์ ์ญ์ ๋ฒํผ ํด๋ฆญ ์ ๋ชจ๋ฌ์ฐฝ์ด ๋ฌ๋ค.
- ๋ชจ๋ฌ์ฐฝ ๋ด ๊ณ์ ์ญ์ ๋ฒํผ ํด๋ฆญ ์ ๊ณ์ ์ด ์ญ์ ๋๊ณ ํํ๋ฉด์ผ๋ก ์ด๋ํ๋ค. |<๋ถ๋งํฌ>
-๋ด๊ฐ ๋ถ๋งํฌํ ๊ฒ์๊ธ์ ์นด๋ํํ๋ก ๋ณผ ์ ์๋ค.
- ์นด๋๋ฅผ ํด๋ฆญํ๋ฉด ํด๋น ๊ฒ์๊ธ๋ก ์ด๋ํ๋ค.
|๋ด๊ฐ ์ด ๊ธ
- ๋ด๊ฐ ์ด ๊ธ๊ณผ ๋ด๊ฐ ์ด ๋๊ธ ๋ชฉ๋ก์ด ๋์ด๋๋ค.
- ์ ๋ชฉ๊ณผ ๋๊ธ์ ํด๋ฆญ์ ๋ณธ์ธ์ด ์์ฑํ ์์ธํ์ด์ง๋ก ์ด๋ํ๋ค.
## ๐ Project Docs
### ์ฌ์ฉ์ ์๊ตฌ์ฌํญ ์ ์์

### ํ๋ฉด ์ ์์

### User Flow

### DB Diagram

### API ๋ช
์ธ์

## ๐ Github Rule
### Commit Convention
| Message | ์ค๋ช
|
| :--------: | :---------------------------------------------------- |
| `feat` | ์๋ก์ด ๊ธฐ๋ฅ ์ถ๊ฐ |
| `fix` | ๋ฒ๊ทธ ์์ |
| `init` | ๋ธ๋์น ์ด๊ธฐํ ๋ฐ ์ด๊ธฐ ์ธํ
๊ด๋ จ๋ ์ค์ |
| `refactor` | ์ฝ๋ ๋ฆฌํฉํ ๋ง |
| `design` | CSS ๋ฑ ์ฌ์ฉ์ UI ๋ณ๊ฒฝ |
| `remove` | ์ฌ์ฉํ์ง ์๋ ํ์ผ ๋๋ ํด๋ ์ญ์ |
| `rename` | ํ์ผ ๋๋ ํด๋๋ช
์์ |
| `test` | ํ
์คํธ ์ฝ๋, ๋ฆฌํํ ๋ง ํ
์คํธ ์ฝ๋ ์ถ๊ฐ |
| `release` | main ๋ฐฐํฌ ์ release ์ปค๋ฐ |