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

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

๐Ÿ˜จ ๋‹น์‹ ์˜ ํˆฌ์ž ์ˆ˜์ต๋ฅ ์€ ์•ˆ๋…•ํ•˜์‹ ๊ฐ€์š”?
https://github.com/codestates-seb/seb40_main_020

Last synced: about 1 year ago
JSON representation

๐Ÿ˜จ ๋‹น์‹ ์˜ ํˆฌ์ž ์ˆ˜์ต๋ฅ ์€ ์•ˆ๋…•ํ•˜์‹ ๊ฐ€์š”?

Awesome Lists containing this project

README

          

# ๐Ÿ’ธ One Coin (์ฝ”์ธ ๋ชจ์˜ ํˆฌ์ž ์„œ๋น„์Šค)

๋ฐฐํฌ ๋งํฌ : **[ONECOIN ๋ฐ”๋กœ๊ฐ€๊ธฐ]()**

๋ฐ๋ชจ ์˜์ƒ :

ํ”„๋กœ์ ํŠธ ๊ธฐ๊ฐ„ : 2022.11.8 ~ 2022.12.07


## Service Introduction

### ์ฝ”์ธ ์—ดํ’! ๋‚˜๋„ ํ•ด๋ณด๊ณ  ์‹ถ์€๋ฐ, ์ผ๋‹จ ์‹œ์ž‘ํ•ด๋ณผ๊นŒ?

์•”ํ˜ธ ํ™”ํ์— ๋Œ€ํ•œ ๊ด€์‹ฌ์ด ๊ฐˆ ์ˆ˜๋ก ์ฆ๊ฐ€ํ•˜์—ฌ, ๋งŽ์€ ์‚ฌ๋žŒ๋“ค์ด ํˆฌ์ž์˜ ์ˆ˜๋‹จ์œผ๋กœ ์ฐธ์—ฌํ•˜๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค. ๊ทธ๋Ÿฌ๋‚˜, ์ž˜ ์ค€๋น„๋˜์ง€ ์•Š์€ ์ƒํƒœ๋กœ ๋ฌด์ž‘์ • ์ฝ”์ธ ํˆฌ์ž๋ฅผ ์‹œ์ž‘ํ•˜์—ฌ ํ”ผํ•ด๋ฅผ ๋ณด๋Š” ์‚ฌ๋žŒ๋“ค๋„ ํ•จ๊ป˜ ๋งŽ์•„์ง€๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค.

๊ทธ๋ž˜์„œ โ€œ**`๋ชจ์˜ ์ฝ”์ธ ํˆฌ์ž`**โ€ ์„œ๋น„์Šค๋ฅผ ์ค€๋น„ํ–ˆ์Šต๋‹ˆ๋‹ค. ์ €ํฌ ์„œ๋น„์Šค๋ฅผ ํ†ตํ•ด ์‹ค์ „์ฒ˜๋Ÿผ ์œ„ํ—˜ ๋ถ€๋‹ด ์—†์ด ์—ฐ์Šต์„ ํ•ด๋ณด๋ฉฐ ์ฝ”์ธ์— ๋Œ€ํ•ด ๋ฐฐ์›Œ๊ฐˆ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์‹ค์ œ ๊ฑฐ๋ž˜๋˜๊ณ  ์žˆ๋Š” ์ƒํ’ˆ๊ณผ ๊ฐ€๊ฒฉ ์ •๋ณด๋ฅผ ๊ทธ๋Œ€๋กœ ๋ฐ˜์˜ํ•˜์—ฌ, ์‹ค์ œ ๋งˆ์ผ“์—์„œ ํ•ด๋‹น ๊ฐ€๊ฒฉ์— ๊ฑฐ๋ž˜๊ฐ€ ์ผ์–ด๋‚ฌ์„ ๋•Œ ๊ฑฐ๋ž˜๊ฐ€ ์ฒด๊ฒฐ๋ฉ๋‹ˆ๋‹ค. ๋˜ํ•œ, ๋ชจ์˜ ํˆฌ์ž์™€ ๋™์‹œ์— ํ•  ์ˆ˜ ์žˆ๋Š” โ€œ**`์‹ค์‹œ๊ฐ„ ์ฑ„ํŒ…`**โ€ ์„œ๋น„์Šค๋ฅผ ํ†ตํ•ด, ์—ฌ๋Ÿฌ ์‚ฌ๋žŒ๋“ค๊ณผ ์ฝ”์ธ์— ๋Œ€ํ•œ ์˜๊ฒฌ์„ ๊ณต์œ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๊ถ๊ทน์ ์œผ๋กœ ์ €ํฌ๋Š” ์ด ์„œ๋น„์Šค๋ฅผ ํ†ตํ•ด, ์‹ค์ œ ํˆฌ์ž ์ด์ „์— ์—ฐ์Šต์„ ํ•ด๋ด„์œผ๋กœ์จ ๋”์šฑ ์‹ ์ค‘ํžˆ ๊ณ ๋ฏผ์„ ํ•  ์ˆ˜ ์žˆ๋„๋ก ๋„์šธ ์ˆ˜ ์žˆ์„ ๊ฒƒ์ด๋ผ ๊ธฐ๋Œ€ํ•ฉ๋‹ˆ๋‹ค.



## Team Members
|Front-end|Front-end|Front-end|Back-end|Back-end|Back-end|
|:--:|:--:|:--:|:--:|:--:|:--:|
|(ํŒ€์žฅ)์„œ์žฌํ™|๊น€๋ฏผ์ƒ|๋ฏผ๋‹ค์˜|๊น€๊ธฐํ™|๋‚จ๊ธฐ๋ฒ”|๊น€์ง€ํ™˜|
|||||||
|[@jaehongg](https://github.com/jaehongg)|[@minsang98](https://github.com/minsang98)|[@MINDA01](https://github.com/MINDA01)|[@broaden-horizon](https://github.com/broaden-horizon)|[@GIVEN53](https://github.com/GIVEN53)|[@kjh42447](https://github.com/kjh42447)|



## ER-Diagram
![image](https://user-images.githubusercontent.com/99868638/205669986-00876c20-adc6-4dc3-bf5b-70bd0477ef66.png)



## NoSQL Modeling
![image](https://user-images.githubusercontent.com/99868638/205670653-76c48084-fcd8-4313-8986-9ecfe991af6b.png)



## Built With



## Service Architecture



## Documentation
[์š”๊ตฌ์‚ฌํ•ญ ์ •์˜์„œ](https://given53.notion.site/84815a9ddea94523a5b42ff09b5f925d?v=d506d3c461c041baa5f01e7cd5ea1808)

[ํ™”๋ฉด ์ •์˜์„œ](https://www.figma.com/file/92A3jCXPtcod2gesRwR6X7/1Coin?node-id=114%3A2)

[API ๋ช…์„ธ์„œ](https://given53.notion.site/1df69396c52a4528a716de7c07cb6d69?v=53ae6a171547493d82822a3c18bc6d3b)



## Commit Message Convention
- โœจfeat: ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€, ๊ธฐ์กด์˜ ๊ธฐ๋Šฅ์„ ์š”๊ตฌ ์‚ฌํ•ญ์— ๋งž์ถ”์–ด ์ˆ˜์ •
- ๐Ÿ›fix: ๊ธฐ๋Šฅ์— ๋Œ€ํ•œ ๋ฒ„๊ทธ ์ˆ˜์ •
- ๐Ÿ‘ทbuild: ๋นŒ๋“œ ๊ด€๋ จ ์ˆ˜์ •
- ๐Ÿ“ฆchore: ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ € ์ˆ˜์ •, ๊ทธ ์™ธ ๊ธฐํƒ€ ์ˆ˜์ • ex) .gitignore
- ๐Ÿ“docs: ๋ฌธ์„œ(์ฃผ์„) ์ˆ˜์ •
- ๐ŸŽจstyle: ์ฝ”๋“œ ์Šคํƒ€์ผ, ํฌ๋งทํŒ…์— ๋Œ€ํ•œ ์ˆ˜์ •
- โ™ป๏ธrefactor: ๊ธฐ๋Šฅ์˜ ๋ณ€ํ™”๊ฐ€ ์•„๋‹Œ ์ฝ”๋“œ ๋ฆฌํŒฉํ„ฐ๋ง ex) ๋ณ€์ˆ˜ ์ด๋ฆ„ ๋ณ€๊ฒฝ
- ๐Ÿ”–release: ๋ฒ„์ „ ๋ฆด๋ฆฌ์ฆˆ
- ๐Ÿงชtest: ํ…Œ์ŠคํŠธ ์ฝ”๋“œ๊ด€๋ จ
- ๐Ÿ”€merge: ๋ณ‘ํ•ฉ



## Git-flow
Git flow๋Š” main๊ณผ dev ๋‘ ๋ธŒ๋žœ์น˜์™€ dev ์•„๋ž˜์— front์™€ back, ๊ทธ ๋ฐ‘์— feature ๋ณด์กฐ ๋ธŒ๋žœ์น˜๋กœ ์ด๋ฃจ์–ด์ ธ ์žˆ๋‹ค.

![image](https://user-images.githubusercontent.com/107832252/201564387-465833c6-cdbd-48a2-a790-48c8a11b6e2b.png)

---
> 1. **dev ๋ธŒ๋žœ์น˜์˜ ๊ฐ์ž(front,back)์—์„œ ๊ฐœ๋ฐœ์ด ์‹œ์ž‘๋œ๋‹ค.**
> 2. **๊ธฐ๋Šฅ ๊ตฌํ˜„์ด๋‚˜ ๋ฒ„๊ทธ๊ฐ€ ๋ฐœ์ƒํ•˜๋ฉด issue๋ฅผ ์ž‘์„ฑํ•œ๋‹ค.**
> 3. **ํŒ€์›๋“ค์ด issue ํ•ด๊ฒฐ์„ ์œ„ํ•ด dev ๋ธŒ๋žœ์น˜ ๋ฐ‘์—์„œ ์ƒ์„ฑํ•œ front,back/feat/{๊ตฌํ˜„๊ธฐ๋Šฅ} ๋ธŒ๋žœ์น˜์—์„œ ๊ฐœ๋ฐœ์„ ํ•˜๊ณ  commit log๋ฅผ ์ž‘์„ฑํ•œ๋‹ค.**
> 4. **push๋ฅผ ํ•˜๋ฉด pull request๋ฅผ ๋‚ ๋ฆด ์ˆ˜ ์žˆ๋‹ค.**
> 5. **pull request๋ฅผ ํ†ตํ•ด ํŒ€์›๋“ค ๊ฐ„์˜ ํ”ผ๋“œ๋ฐฑ, ๋ฒ„๊ทธ ์ฐพ๋Š” ๊ณผ์ •์ด ์ง„ํ–‰๋œ๋‹ค.
> release ๋ธŒ๋žœ์น˜๊ฐ€ ์—†์œผ๋ฏ€๋กœ ์ด ๊ณผ์ •์ด ํƒ„ํƒ„ํ•˜๊ฒŒ ์ง„ํ–‰๋˜์–ด์•ผ ํ•œ๋‹ค.**
> 6. **๋ชจ๋“  ๋ฆฌ๋ทฐ๊ฐ€ ์ด๋ฃจ์–ด์ง€๋ฉด, mergeํ•˜๊ธฐ ์ „์— ๋ฐฐํฌ๋ฅผ ํ†ตํ•ด ์ตœ์ข… ํ…Œ์ŠคํŠธ๋ฅผ ์ง„ํ–‰ํ•œ๋‹ค.**
> 7. **ํ…Œ์ŠคํŠธ๊นŒ์ง€ ์ง„ํ–‰๋˜๋ฉด main ๋ธŒ๋žœ์น˜์— ๋จธ์ง€ํ•œ๋‹ค.**
---