-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
πdesign: readme λμμΈ μμ (#43)
- Loading branch information
1 parent
36fc376
commit 172fe0b
Showing
1 changed file
with
116 additions
and
25 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,35 +1,126 @@ | ||
# Stock2U-Front | ||
# π μ¬κ³ ν맀 μΉ μλΉμ€, Stock2U | ||
|
||
## Git branching model | ||
![mainPage](/public/svg/brand/logo-text.svg) <br> | ||
|
||
<aside> | ||
π **Base λΈλμΉ(upstream)μ μ’ λ₯** | ||
<div align='center'> | ||
|
||
- `main` - λ¦΄λ¦¬μ¦ | ||
- `develop` - κ°λ° | ||
[π» μ¬μ΄νΈ λ°λ‘κ°κΈ°](https://www.pastforward.link) | ||
<br> | ||
|
||
**Local λΈλμΉμ μ’ λ₯** | ||
</div> | ||
<br> | ||
|
||
- `feature/{ticket|name}` - κ³νλ νΌμ³ κ°λ°(T1) | ||
- `fix/{ticket|name}` - κ³νλ ν¨μΉ μ μ©(T2) | ||
- `hotfix/{ticket|name}` - κ³νλμ§ μμ κΈ΄κΈ μμ (T3) | ||
</aside> | ||
## νλ‘μ νΈ μκ° | ||
|
||
## Commit guide | ||
- Stock2Uλ μ¬κ³ μμ§μ΄ μΌλ§ λ¨μ§ μμ ν맀 μνμ ν μΈν κ°κ²©μΌλ‘ ꡬ맀μμκ² ν맀ν μ μλ μΉμλΉμ€μ λλ€. | ||
- μ£Όμ κΈ°λ₯μ μμΉ κΈ°λ° μ¬κ³ μν νμΈ κΈ°λ₯, μ±ν κΈ°λ₯, μν λ±λ‘ λ° μμΈνμ΄μ§,νλ‘ν μ€μ λ±μ΄ μμ΅λλ€. | ||
|
||
- `feat:` - μλ‘μ΄ κΈ°λ₯μ λν μ»€λ° | ||
- `fix:` - λ²κ·Έ μμ μ λν μ»€λ° | ||
- `build:` - λΉλ κ΄λ ¨ νμΌ μμ μ λν μ»€λ° | ||
- `chore:` - κ·Έ μΈ μμν μμ μ λν μ»€λ° | ||
- `docs:` - λ¬Έμ μμ μ λν μ»€λ° | ||
- `style:` - μ½λ μ€νμΌ νΉμ ν¬λ§· λ±μ κ΄ν μ»€λ° | ||
- `refactor:` - μ½λ 리ν©ν λ§μ λν μ»€λ° | ||
- `test:` - ν μ€νΈ μ½λ μμ μ λν μ»€λ° | ||
<br> | ||
|
||
## Code review guide | ||
## νμ κ΅¬μ± | ||
|
||
νμν κ²½μ° μλμ λ§λ¨Έλ¦¬λ₯Ό μ¬μ©ν΄ μ£ΌμΈμ. | ||
<div align="center"> | ||
|
||
- [μ§λ¬Έ] - λ¨μ μ§λ¬Έ. ν΄κ²°λμ§ μμλ λ¨Έμ§ κ°λ₯ | ||
- [μ견] - λ¨μ κ°λ¨ μ견. ν΄κ²°λμ§ μμλ λ¨Έμ§ κ°λ₯ | ||
- [λ³κ²½μμ²] - λμνμ§ μλ λΆλΆμ΄λ μλͺ»λ λΆλΆμ΄ μμ λ(λ°λμ μμ νμ) | ||
| Front-End | Front-End | Front-End | | ||
| :----------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------: | | ||
| <img src="https://github.com/bear-bear-bear.png?size=120" title="" alt="μ λ―Ό2.png" width="100%"> | <img src="https://github.com/heejung0413.png?size=120" title="" alt="μν¬μ .png" width="100%"> | <img src="https://github.com/Ellsy23.png?size=120" title="" alt="μ΄μ€ν.png" width="100%"> | | ||
| κΉμ¬μ€ | μν¬μ | μ΄μ€ν | | ||
| [@bear-bear-bear](https://github.com/bear-bear-bear) | [@bheejung0413](https://github.com/heejung0413) | [@Ellsy23](https://github.com/Ellsy23) | | ||
|
||
</div> | ||
|
||
<br> | ||
|
||
## 1. κ°λ° νκ²½ | ||
|
||
- Front : HTML, React, Chakra UI, Recoil, TypeScript, axios, vite, husky, prettier, ESLint, babel | ||
- Back-end : μ 곡λ API νμ© | ||
- λ²μ λ° μ΄μκ΄λ¦¬ : Github, Confluence, Jira | ||
- νμ ν΄ : GatherTown, Notion, Slack | ||
- μλΉμ€ λ°°ν¬ νκ²½ : Vercel | ||
- π¨ λμμΈ : [Figma](https://www.figma.com/design/0Qmoy4VGV5lesJ2GnHj8j7/%EB%A9%80%ED%8B%B0%EC%BA%A0%ED%8D%BC%EC%8A%A4-%ED%95%B4%EC%BB%A4%ED%86%A4-2023?node-id=0-1&t=r2f98qCZlpU9L7i1-1) | ||
- π©π»βπ» μ΄μ κ΄λ¦¬ : [Jira](https://geezers-io.atlassian.net/jira/software/projects/SU/boards/1/backlog?epics=visible) | ||
|
||
<br> | ||
|
||
## 2. μ±νν κ°λ° κΈ°μ | ||
|
||
### React, Typescript | ||
|
||
- React | ||
- μ»΄ν¬λνΈνλ₯Ό ν΅ν΄ μΆν μ μ§λ³΄μμ μ¬μ¬μ©μ±μ κ³ λ €νμ΅λλ€. | ||
- μ μ λ°°λ, μλ¨κ³Ό νλ¨ λ°°λ λ± μ€λ³΅λμ΄ μ¬μ©λλ λΆλΆμ΄ λ§μ μ»΄ν¬λνΈνλ₯Ό ν΅ν΄ 리μμ€ μ μ½μ΄ κ°λ₯νμ΅λλ€. | ||
- Typescript | ||
- μμ μ μΈ κ°λ°κ³Ό λμ μ½λ μμ€μ μ½λ νμ§μ μ μ§νλ €λ©΄ μ μ νμ λ¬Έλ²μ μΆκ°ν΄ κ°λ°νλ κ²μ΄ νΈλ¦¬νλ€ μκ°νμ΅λλ€. | ||
- λ³μ νμ μ μ§μ νκ³ javascriptλ‘ μ»΄νμΌλμ΄ μ€νν μ μμ΅λλ€. | ||
- μ»΄νμΌ κ³Όμ μμ νμ μ μ§μ ν¨μΌλ‘μ¨, μλ¬ μλ°©κ³Ό μμ¬μ΄ λλ²κΉ μ΄ κ°λ₯νμ΅λλ€. | ||
|
||
### Chakra UI | ||
|
||
- Chakra UI | ||
- React μ ν리μΌμ΄μ μ λΉλνλλ° νμν λΈλ‘μ κ°λ¨νκ³ λͺ¨λμ μ΄λ©° μ κ·Ό κ°λ₯νκ² λ§λ€ μ μλ UI μ»΄ν¬λνΈ λΌμ΄λΈλ¬λ¦¬μ λλ€. | ||
|
||
### eslint, prettier | ||
|
||
- μ ν΄μ§ κ·μΉμ λ°λΌ μλμ μΌλ‘ μ½λ μ€νμΌμ μ λ¦¬ν΄ μ½λμ μΌκ΄μ±μ μ μ§νκ³ μ νμ΅λλ€. | ||
- μ½λ νμ§ κ΄λ¦¬λ eslintμ, μ½λ ν¬λ§·ν μ prettierμ μΌμν΄ μ¬μ©νμ΅λλ€. | ||
- airbnbμ μ½λ© 컨벀μ μ μ°Έκ³ ν΄ μ¬μ©νκ³ , μμΈ κ·μΉμ νμλ€κ³Ό νμνμ΅λλ€. | ||
- νμ μ λ§€λ² μ»¨λ²€μ μ μ κ²½ μΈ νμ μμ΄ λΉ λ₯΄κ² κ°λ°νλ λ°μ λͺ©μ μ λμμ΅λλ€. | ||
|
||
<br> | ||
|
||
## 3. μν λΆλ΄ | ||
|
||
### π€© κΉμ¬μ€ | ||
|
||
- **UI** | ||
- νμ΄μ§ : λ‘κ·ΈμΈ/νμκ°μ νμ΄μ§, μ¬κ³ μν μ§λ νμ΄μ§, λ μ΄μμ | ||
- **κΈ°λ₯** | ||
- μΈμ¦ μ²λ¦¬ | ||
- μ¬κ³ μν μ§λ κΈ°λ° μλΉμ€ ꡬν | ||
- κ°λ°νκ²½ κ΅¬μΆ (vite μ¬μ©) | ||
|
||
<br> | ||
|
||
### π»μν¬μ | ||
- **UI** | ||
- νμ΄μ§ : μν λ±λ‘ νμ΄μ§, μν μμΈ νμ΄μ§, νλ‘ν νμ΄μ§ | ||
- κ³΅ν΅ μ»΄ν¬λνΈ : μ΄λ―Έμ§ μ λ‘λ μ»΄ν¬λνΈ κ΅¬ν | ||
|
||
- **κΈ°λ₯** | ||
- μν λ±λ‘ κΈ°λ₯ ꡬν (μ΄λ―Έμ§ νμΌ μ λ‘λ, μ λͺ©/μμΈμ€λͺ /κΈ°κ° μ§μ ) | ||
- ν맀μ ꡬλ κΈ°λ₯ | ||
- νλ‘ν μ€μ | ||
|
||
<br> | ||
|
||
### π©π»βπ» μ΄μ€ν | ||
|
||
- **UI** | ||
|
||
- νμ΄μ§: λ©μΈνμ΄μ§, νλ‘ν νμ΄μ§ | ||
- κ³΅ν΅ μ»΄ν¬λνΈ, μ΄λ―Έμ§ μΊλ¬μ , νμ΄μ§λ€μ΄μ , μΈνΌλν°μ€ν¬λ‘€ μ»΄ν¬λνΈ κ΅¬ν | ||
|
||
- **κΈ°λ₯** | ||
- λ©μΈνμ΄μ§ μ 체μ μΈ κΈ°λ₯ ꡬν | ||
|
||
<br> | ||
|
||
<br> | ||
|
||
## 4. κ°λ° κΈ°κ° λ° μμ κ΄λ¦¬ | ||
|
||
### κ°λ° κΈ°κ° | ||
|
||
- μ 체 κ°λ° κΈ°κ° : 2023.09.24 - 2023.01.09 | ||
|
||
<br> | ||
|
||
### μμ κ΄λ¦¬ | ||
|
||
- GitHub Projectsλ‘ λ°±μλμμ issue μν©μ νμ νλ©° νλ‘μ νΈλ₯Ό μ§ννμμ΅λλ€. | ||
- issue λ²νΈμ λ°λΌ λΈλμΉ λ€μμ μ νλ©° μ λ΅μ λ§μΆμ΄ λΈλμΉλ₯Ό μμ±νμμ΅λλ€. | ||
|
||
<br> | ||
|
||
<br> |