Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nalsae/grow-story
๐ฑ Grow Story : ์๋ฌผ์ ๊ด๋ฆฌํ๊ณ ๋๋ง์ ์ ์์ ๊พธ๋ฉฐ ๋ณด์ธ์ ๐ฑ
https://github.com/nalsae/grow-story
docker framer-motion gradle java mysql next react-query spring-boot tailwindcss typescript zustand
Last synced: about 2 months ago
JSON representation
๐ฑ Grow Story : ์๋ฌผ์ ๊ด๋ฆฌํ๊ณ ๋๋ง์ ์ ์์ ๊พธ๋ฉฐ ๋ณด์ธ์ ๐ฑ
- Host: GitHub
- URL: https://github.com/nalsae/grow-story
- Owner: nalsae
- Fork: true (codestates-seb/seb45_main_011)
- Created: 2023-08-30T02:04:32.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-09T00:18:37.000Z (6 months ago)
- Last Synced: 2024-05-09T01:31:06.318Z (6 months ago)
- Topics: docker, framer-motion, gradle, java, mysql, next, react-query, spring-boot, tailwindcss, typescript, zustand
- Language: TypeScript
- Homepage: https://grow-story.vercel.app/
- Size: 8.49 MB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ๐ณ Grow Story
![main](https://github.com/nalsae/seb45_main_011/assets/101828759/1d9742ff-27eb-4ac2-8e59-d56bbade03d3)
๐ฑ ์๋ฌผ์ ๊ด๋ฆฌํ๊ณ ๋๋ง์ ์ ์์ ๊พธ๋ฉฐ ๋ณด์ธ์ ๐ฑ
> ๐ค ํค์ฐ๋ ์๋ฌผ์ ์์ฝ๊ณ ์ฌ๋ฏธ์๊ฒ ๊ด๋ฆฌํ ์ ์๋ ๋ฐฉ๋ฒ ์์๊น?
>
> ์๋ฌผ์ ์์ฝ๊ฒ ๋ฑ๋กํ๊ณ ๊ด๋ฆฌํ ์ ์๋ **์๋ฌผ ์นด๋** ๊ธฐ๋ฅ,
> ๋ด ์๋ฌผ์ ์๋ํ๊ณ ๋ค์ํ ์์ง์ฌ๋ค๊ณผ ์ํตํ ์ ์๋ **์ปค๋ฎค๋ํฐ** ๊ธฐ๋ฅ,
> ํ๋ํด์ ํ๋ํ ํฌ์ธํธ๋ก ๊พธ๋ฐ ์ ์๋ **๋๋ง์ ์ ์** ๊ธฐ๋ฅ๊น์ง!
>
> ๐ณ **Grow Story** ๐ณ์์๋ ์ด ๋ชจ๋ ๊ฒ์ด ๊ฐ๋ฅํฉ๋๋ค ๐
---
## ๐ฉ ํ๋ก์ ํธ ๊ฐ์
- **ํ๋ก์ ํธ ๋ช ** : Grow Story
- **์งํ ๊ธฐ๊ฐ** : 23.08.24 ~ 23.09.19
- **์๋น์ค URL** : [๐ณ Grow Story ๐ณ ๋ฐ๋ก ๊ฐ๊ธฐ](https://grow-story.vercel.app/)
## ๐จโ๐ฉโ๐งโ๐ฆ ํ์ ์๊ฐ
| ๊น๋ฏผ์ | ์ฌ๋์ฐ | ์ตํ๋น | ํฉ๋๊ฒฝ | ๊น๋ํ | ์ด์นํ |
| :-----------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------: |
| | | | | | |
| [@nalsae](https://github.com/nalsae) | [@shimdokite](https://github.com/shimdokite) | [@hanbinchoi](https://github.com/hanbinchoi) | [@Smile:DK](https://github.com/Dokyung-Hwang) | [@dohyoungK](https://github.com/dohyoungK) | [@NtoZero](https://github.com/NtoZero) |
| **FE** (๋ถํ์ฅ) | **FE** | **FE** | **BE** (ํ์ฅ) | **BE** | **BE** |
## ๐ง ๊ธฐ์ ์คํ
![Web App Reference Architecture (1)](https://github.com/nalsae/seb45_main_011/assets/101828759/86f50a74-2e0c-4a5d-8865-45e95f595593)
## ๐ ๊ด๋ จ ๋ฌธ์
#### [๐ ์๊ตฌ์ฌํญ ์ ์์](https://docs.google.com/spreadsheets/d/1DfUeCgU0jrdEpSmEmLVWainZ1wjpvFihpR83t6NWGdw/edit#gid=160309127)
#### [๐ ํ๋ฉด ์ ์์](https://www.figma.com/file/yL1b8KClwZHoBXDcCp4wei/GrowStroy?type=design&node-id=1-8&mode=design)
#### [๐ API ๋ช ์ธ์](https://documenter.getpostman.com/view/27565928/2s9Y5YS34h)
#### [๐ ERD](https://www.figma.com/file/yL1b8KClwZHoBXDcCp4wei/GrowStroy?type=design&node-id=1-8&mode=design)
![ERD GrowStory_final](https://github.com/nalsae/seb45_main_011/assets/101828759/35b133c5-790e-48cf-be56-8eb2f4c54522)
## ๐ค ๊ธฐ์ ๋ฐํ
#### [๐ ๋ฐํ ์์ ๋ฐ๋ก ๊ฐ๊ธฐ](https://www.youtube.com/watch?v=GHia0UGUqTw)
## ๐ ์๋น์ค ๋งค๋ด์ผ
#### [๐ฅ ์๋น์ค ๋งค๋ด์ผ ๋ค์ด๋ก๋](https://github.com/nalsae/seb45_main_011/files/12662276/Grow.Story.pdf)
## ๐ฅ ๊ตฌํ ์ด๋ฏธ์ง
| ํ์ด์ง (๊ธฐ๋ฅ) | ์ด๋ฏธ์ง |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| ๋ฉ์ธ | ![๋ฉ์ธ ํ์ด์ง](https://github.com/nalsae/seb45_main_011/assets/101828759/7e293d8a-9934-4aa8-b3af-e6ccd7aa112b) |
| ๋ก๊ทธ์ธ | ![๋ก๊ทธ์ธ ํ์ด์ง](https://github.com/nalsae/seb45_main_011/assets/101828759/7b393893-9c3b-45a3-aa21-748f46b8b522) |
| ํ์ ๊ฐ์ | ![ํ์ ๊ฐ์ ํ์ด์ง](https://github.com/nalsae/seb45_main_011/assets/101828759/9b6db6ec-0e98-4267-a172-c2adf29a9fb9) |
| ์ ์ (๊พธ๋ฏธ๊ธฐ) | ![์ ์ ํ์ด์ง - ๊พธ๋ฏธ๊ธฐ](https://github.com/nalsae/seb45_main_011/assets/101828759/de3caba6-42f5-4708-ad9c-8bd2e50a4231) |
| ์ ์ (์ฅ์ํ ๊ตฌ๋งค) | ![์ ์ ํ์ด์ง - ๊ตฌ๋งค](https://github.com/nalsae/seb45_main_011/assets/101828759/49c9acf3-b06d-44e9-9a16-208f8a022b63) |
| ์ ์ (์๋ฌผ ์นด๋ ์ฐ๋) | ![์ ์ ํ์ด์ง - ์๋ฌผ ์นด๋ ์ฐ๋](https://github.com/nalsae/seb45_main_011/assets/101828759/ef6da970-f632-45b8-b0f9-eb737d5b9903) |
| ์๋ฌผ ์นด๋ ๋ชฉ๋ก, ๋ฑ๋ก | ![์๋ฌผ์นด๋ ๋ชฉ๋ก](https://github.com/nalsae/seb45_main_011/assets/101828759/a7f05c66-9a9b-4ff0-a32d-08599fb4dd9a) |
| ์๋ฌผ ์นด๋ ์์ธ | ![์๋ฌผ ์นด๋ ์์ธ](https://github.com/nalsae/seb45_main_011/assets/101828759/38ab89f9-ec9c-4410-aeb9-83e9cd09ca7e) |
| ์๋ฌผ ์นด๋ ์์ , ์ญ์ | ![์๋ฌผ ์นด๋ ์์ , ์ญ์ ](https://github.com/nalsae/seb45_main_011/assets/101828759/6fe42722-8676-4eee-bd00-27bc16c9c9f0) |
| ์ปค๋ฎค๋ํฐ | ![์ปค๋ฎค๋ํฐ](https://github.com/nalsae/seb45_main_011/assets/101828759/a27f3bfd-3346-4070-a6b8-082b5708f73a) |
| ๊ฒ์๊ธ ์์ธ | ![๊ฒ์๊ธ ์์ธ](https://github.com/nalsae/seb45_main_011/assets/101828759/128584db-95cd-4edf-9161-74962f67d645) |
| ๊ฒ์๊ธ ๋ฑ๋ก | ![๊ฒ์๊ธ ๋ฑ๋ก](https://github.com/nalsae/seb45_main_011/assets/101828759/211bd724-984e-45b8-989a-4c59246dbec2) |
| ๊ฒ์๊ธ ์์ , ์ญ์ | ![๊ฒ์๊ธ ์์ , ์ญ์ ](https://github.com/nalsae/seb45_main_011/assets/101828759/1ea79b6f-2717-406b-89f4-adbdfcaa785e) |
| ๋๊ธ ๋ฑ๋ก, ์์ , ์ญ์ | ![๋๊ธ ๋ฑ๋ก, ์์ , ์ญ์ ](https://github.com/nalsae/seb45_main_011/assets/101828759/52ccd8f0-5e30-4198-bfc9-2dca9b28b870) |
| ์ ๋ณด ์์ | ![์ ๋ณด ์์ ](https://github.com/nalsae/seb45_main_011/assets/101828759/a74749c1-d239-48cc-ac55-f6eda46ff228) |
| ๋ด ๊ฒ์๊ธ | ![๋ด ๊ฒ์๊ธ](https://github.com/nalsae/seb45_main_011/assets/101828759/9d05dd7d-0cd3-4f86-b0b8-43b5438ba724) |
| ํ์ ํํด | ![ํ์ ํํด](https://github.com/nalsae/seb45_main_011/assets/101828759/120777f3-9c77-4681-bd3c-78cd5204c90e) |
## ๐ค ์ปจ๋ฒค์
๐ Issue
1. ์ ๋ชฉ
- ์์ ๋ด์ฉ์ ๋ฐ๋ผ ์ปค๋ฐ ๋ฉ์์ง์ ์ฌ์ฉํ๋ Gitmoji๋ฅผ ์ ์ ํ๊ฒ ์์ฑ
- ์์ ์ด ์์ ํ ๋ด์ฉ์ ํ ๋์ ํ์ ํ๊ธฐ ์ฝ๋๋ก ๋ช ์ฌํ์ผ๋ก ์์ฑ
```
[FE/BE] โจ OOO ์ปดํฌ๋ํธ ๊ตฌํ
```2. ๋ด์ฉ
## Abstracts
* ๊ฐ๋ตํ๊ฒ ํ ์ผ์ ๋ํ ์ค๋ช ์ ์์ฑํด์ฃผ์ธ์.## To Do
- [ ] ๊ตฌํํ ๊ธฐ๋ฅ 1
- [ ] ๊ตฌํํ ๊ธฐ๋ฅ 2## ETC
* ์ถ๊ฐ์ ์ธ ์๋ด ์ฌํญ์ด ์๋ค๋ฉด ์์ฑํด์ฃผ์ธ์.
๐ Commit
- ์ปค๋ฐ ๋ฉ์์ง
1. ์ ์ ํ ์ปค๋ฐ ์ ๋์ฌ ์์ฑ
2. ์ปค๋ฐ ๋ฉ์์ง ๋ด์ฉ ์์ฑ
3. ๋ด์ฉ ๋ค์ ์ด์ (#์ด์ ๋ฒํธ)์ ๊ฐ์ด ์์ฑํ์ฌ ์ด์ ์ฐ๊ฒฐ[FE/BE] ๐ง Conf: ์ด๊ธฐ ํ๊ฒฝ ์ค์ (#1)
| ์ ๋์ฌ | ์ค๋ช |
| ------------- | ------------------------------ |
| โจ Feat : | ์๋ก์ด ๊ธฐ๋ฅ ๊ตฌํ |
| ๐ฑ Add : | ์์ ํ์ผ ์ถ๊ฐ |
| ๐ Fix : | ๋ฒ๊ทธ ์์ |
| ๐ Docs : | ๋ฌธ์ ์ถ๊ฐ ๋ฐ ์์ |
| ๐ Style : | ์คํ์ผ๋ง ์์ |
| โป๏ธ Refactor : | ์ฝ๋ ๋ฆฌํฉํ ๋ง (๋์ ๋ณ๊ฒฝ ์์) |
| ๐งช Test : | ํ ์คํธ |
| ๐ Deploy : | ๋ฐฐํฌ |
| ๐ง Conf : | ๋น๋, ํ๊ฒฝ ์ค์ |
| โ๏ธ Chore : | ๊ธฐํ ์์ |
๐ Pull Request
1. ์ ๋ชฉ
- ์์ ๋ด์ฉ์ ๋ฐ๋ผ ์ปค๋ฐ ๋ฉ์์ง์ ์ฌ์ฉํ๋ Gitmoji๋ฅผ ์ ์ ํ๊ฒ ์์ฑ
- ์์ ์ด ์์ ํ ๋ด์ฉ์ ํ ๋์ ํ์ ํ๊ธฐ ์ฝ๋๋ก ๋ช ์ฌํ์ผ๋ก ์์ฑ```
[FE/BE] โจ OOO ์ปดํฌ๋ํธ ๊ตฌํ
```2. ๋ด์ฉ
## Title
* ์ ๋ชฉ์ 'โจ ํ ํ์ด์ง ๊ตฌํ'๊ณผ ๊ฐ์ด ์์ฑํฉ๋๋ค.## PR Type
- [ ] FEAT: ์๋ก์ด ๊ธฐ๋ฅ ๊ตฌํ
- [ ] ADD : ์์ ํ์ผ ์ถ๊ฐ
- [ ] FIX: ๋ฒ๊ทธ ์์
- [ ] DOCS: ๋ฌธ์ ์ถ๊ฐ ๋ฐ ์์
- [ ] STYLE: ํฌ๋งทํ ๋ณ๊ฒฝ
- [ ] REFACTOR: ์ฝ๋ ๋ฆฌํฉํ ๋ง
- [ ] TEST: ํ ์คํธ ๊ด๋ จ
- [ ] DEPLOY: ๋ฐฐํฌ ๊ด๋ จ
- [ ] CONF: ๋น๋, ํ๊ฒฝ ์ค์
- [ ] CHORE: ๊ธฐํ ์์## Abstracts
* ์์ ๋ด์ฉ์ ๋ํด ๊ฐ๋ตํ๊ฒ ์ค๋ช ์ ์์ฑํด์ฃผ์ธ์.## Description
* ๊ตฌ์ฒด์ ์ธ ์์ ๋ด์ฉ์ ์์ฑํด์ฃผ์ธ์.
* ์ด๋ฏธ์ง๋ฅผ ๋ณ๋๋ก ์ฒจ๋ถํ๋ฉด ๋ ์ข์ต๋๋ค ๐## Discussion
* ์ถํ ๋ ผ์ํ ์ ์ ๋ํด ์์ฑํด์ฃผ์ธ์.---
Close #1
(์์ฑํ Issue๋ฅผ ์ฐ๊ฒฐํด์ฃผ์ธ์.)