Skip to content

TWC-codeit/TWC_FE

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

118 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

TWC_FE

๐Ÿ›  ๊ธฐ์ˆ  ์Šคํƒ

์—ญํ•  ์ข…๋ฅ˜ ์„ ์ • ์ด์œ 
Library ํŒ€์› ๊ธฐ์ˆ  ์ˆ˜์ค€ ๊ณ ๋ ค ๋ฐ ๊ฐ•๋ ฅํ•œ ์ƒํƒœ๊ณ„์™€ ์ปค๋ฎค๋‹ˆํ‹ฐ ์ง€์›์„ ํ†ตํ•ด ํšจ์œจ์ ์ธ ์ปดํฌ๋„ŒํŠธ ๊ธฐ๋ฐ˜ UI ๊ฐœ๋ฐœ ๊ฐ€๋Šฅ
Programming Language ์‰ฌ์šด ๋””๋ฒ„๊น… ๋ฐ ์œ ์—ฐํ•œ ์ฝ”๋“œ ์ž‘์„ฑ ๊ฐ€๋Šฅ
Styling CSS-in-JS ๋ฐฉ์‹์˜ ์ปดํฌ๋„ŒํŠธ ๊ธฐ๋ฐ˜ ์Šคํƒ€์ผ๋ง ๋ฐฉ์‹์œผ๋กœ ๊ด€๋ฆฌ๊ฐ€ ๊ฐ„ํŽธ
Data Fetching json ์—ํ‹ฐํ„ฐ ์ž๋™ ๋ณ€ํ™˜ ๊ธฐ๋Šฅ์œผ๋กœ ์‚ฌ์šฉ ํŽธ์˜
Routing ์ง๊ด€์ ์ธ ๋ผ์šฐํŒ… ๊ด€๋ฆฌ ๋ฐ ๋‹ค์–‘ํ•œ ์˜ต์…˜ ์ œ๊ณต
Formatting ์ฝ”๋“œ ํ’ˆ์งˆ์„ ๋ณด์žฅํ•˜๊ณ  ์ผ๊ด€๋œ ์ฝ”๋“œ ์Šคํƒ€์ผ์„ ์œ ์ง€
Package Manager ํŒ€์›์˜ ๊ธฐ์ˆ  ์ˆ˜์ค€ ๊ณ ๋ ค
Deployment ์„œ๋ฒ„ ๋ฐฐํฌ์— ๋งž์ถฐ์„œ http ๋ฐฐํฌ๋ฅผ ์œ„ํ•ด ์„ ์ •
Bundler ๋น ๋ฅธ ๊ฐœ๋ฐœ ํ™˜๊ฒฝ ์„ค์ •๊ณผ HMR์„ ์ง€์›ํ•˜์—ฌ ๊ฐœ๋ฐœ ์ƒ์‚ฐ์„ฑ์„ ํ–ฅ์ƒ

โœ… Project Run

ํ”„๋กœ์ ํŠธ ์‹คํ–‰ ๋ฐฉ๋ฒ•

  • ๋ช…๋ น์–ด: npm run dev
  • port ๋ฒˆํ˜ธ: 3000

๐Ÿ”— Git Convention

๐Ÿ”ฅ Commit Message Convention

์ปค๋ฐ‹ ์œ ํ˜• ์„ค๋ช…
Init ์ดˆ๊ธฐ ์„ธํŒ…์‹œ ์‚ฌ์šฉ
Feat ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€
Fix ๋ฒ„๊ทธ ์ˆ˜์ •
Docs ๋ฌธ์„œ ์ถ”๊ฐ€, ์ˆ˜์ •, ์‚ญ์ œ
Merge ๋ธŒ๋žœ์น˜ ๋ณ‘ํ•ฉ
Style ์ฝ”๋“œ formatting, ์„ธ๋ฏธ์ฝœ๋ก  ๋ˆ„๋ฝ, ์ฝ”๋“œ ์ž์ฒด์˜ ๋ณ€๊ฒฝ์ด ์—†๋Š” ๊ฒฝ์šฐ
Refactor ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง
Test ํ…Œ์ŠคํŠธ ์ฝ”๋“œ, ๋ฆฌํŒฉํ† ๋ง ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€
Chore ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ € ์ˆ˜์ •, ๊ทธ ์™ธ ๊ธฐํƒ€ ์ˆ˜์ • ex) .gitignore
Build ๋นŒ๋“œ ๊ด€๋ จ ํŒŒ์ผ ์ˆ˜์ •์— ๋Œ€ํ•œ ์ปค๋ฐ‹
Design CSS ๋“ฑ ์‚ฌ์šฉ์ž UI ๋””์ž์ธ ๋ณ€๊ฒฝ
Comment ํ•„์š”ํ•œ ์ฃผ์„ ์ถ”๊ฐ€ ๋ฐ ๋ณ€๊ฒฝ
Rename ํŒŒ์ผ ๋˜๋Š” ํด๋” ๋ช…์„ ์ˆ˜์ •ํ•˜๊ฑฐ๋‚˜ ์˜ฎ๊ธฐ๋Š” ์ž‘์—…๋งŒ์ธ ๊ฒฝ์šฐ
Remove ํŒŒ์ผ์„ ์‚ญ์ œํ•˜๋Š” ์ž‘์—…๋งŒ ์ˆ˜ํ–‰ํ•œ ๊ฒฝ์šฐ

Commit Message ๊ทœ์น™

  • ํ˜•์‹: [์ปค๋ฐ‹์œ ํ˜•/#issue ๋ฒˆํ˜ธ] ์ƒ์„ธ์„ค๋ช…
  • ์˜ˆ์‹œ:
    • [Init/#1] ํ”„๋กœ์ ํŠธ ์ดˆ๊ธฐ ์„ธํŒ…
    • [Feat/#2] ๋ฉ”์ธํŽ˜์ด์ง€ ๊ฐœ๋ฐœ

๐ŸŒฟ Branch Convention

Branch Naming ๊ทœ์น™

  • ํ˜•์‹: prefix/#issue ๋ฒˆํ˜ธ/์ƒ์„ธ๊ธฐ๋Šฅ
  • Prefix ๋ชฉ๋ก:
    • Init: ์ดˆ๊ธฐ ์„ธํŒ…
    • Feat: ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ
    • Fix: ๋ฒ„๊ทธ ์ˆ˜์ •
    • Docs: ๋ฌธ์„œ ์ถ”๊ฐ€, ์ˆ˜์ •, ์‚ญ์ œ
    • Style: ์ฝ”๋“œ formatting, ์„ธ๋ฏธ์ฝœ๋ก  ๋ˆ„๋ฝ ๋“ฑ ์ฝ”๋“œ ์ž์ฒด ๋ณ€๊ฒฝ์ด ์—†๋Š” ์ž‘์—…
    • Refactor: ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง
    • Test: ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ž‘์„ฑ ๋ฐ ๋ฆฌํŒฉํ† ๋ง
    • Chore: ๊ธฐํƒ€ ์ž‘์—… (ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ € ์ˆ˜์ •, .gitignore ๋ณ€๊ฒฝ ๋“ฑ)
    • Build: ๋นŒ๋“œ ๊ด€๋ จ ํŒŒ์ผ ์ˆ˜์ •
    • Design: CSS ๋“ฑ ์‚ฌ์šฉ์ž UI ๋””์ž์ธ ๋ณ€๊ฒฝ
    • Comment: ์ฃผ์„ ์ถ”๊ฐ€ ๋ฐ ๋ณ€๊ฒฝ
    • Rename: ํŒŒ์ผ ๋˜๋Š” ํด๋” ์ด๋ฆ„ ๋ณ€๊ฒฝ ๋ฐ ์ด๋™
    • Remove: ํŒŒ์ผ ์‚ญ์ œ ์ž‘์—…๋งŒ ์ˆ˜ํ–‰ํ•œ ๊ฒฝ์šฐ
  • ์˜ˆ์‹œ:
    • Feat/#1/loginPage
    • Fix/#2/headerBug

๐Ÿ“‹ Issue Convention

Issue Title ๊ทœ์น™

  • ํ˜•์‹: [ํƒœ๊ทธ] ์ œ๋ชฉ
  • ํƒœ๊ทธ ๋ชฉ๋ก:
    • Init: ์ดˆ๊ธฐ ์„ธํŒ…
    • Feat: ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ
    • Fix: ๋ฒ„๊ทธ ์ˆ˜์ •
    • Docs: ๋ฌธ์„œ ์ถ”๊ฐ€, ์ˆ˜์ •, ์‚ญ์ œ
    • Style: ์ฝ”๋“œ formatting, ์„ธ๋ฏธ์ฝœ๋ก  ๋ˆ„๋ฝ ๋“ฑ ์ฝ”๋“œ ์ž์ฒด ๋ณ€๊ฒฝ์ด ์—†๋Š” ์ž‘์—…
    • Refactor: ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง
    • Test: ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ž‘์„ฑ ๋ฐ ๋ฆฌํŒฉํ† ๋ง
    • Chore: ๊ธฐํƒ€ ์ž‘์—… (ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ € ์ˆ˜์ •, .gitignore ๋ณ€๊ฒฝ ๋“ฑ)
    • Build: ๋นŒ๋“œ ๊ด€๋ จ ํŒŒ์ผ ์ˆ˜์ •
    • Design: CSS ๋“ฑ ์‚ฌ์šฉ์ž UI ๋””์ž์ธ ๋ณ€๊ฒฝ
    • Comment: ์ฃผ์„ ์ถ”๊ฐ€ ๋ฐ ๋ณ€๊ฒฝ
    • Rename: ํŒŒ์ผ ๋˜๋Š” ํด๋” ์ด๋ฆ„ ๋ณ€๊ฒฝ ๋ฐ ์ด๋™
    • Remove: ํŒŒ์ผ ์‚ญ์ œ ์ž‘์—…๋งŒ ์ˆ˜ํ–‰ํ•œ ๊ฒฝ์šฐ
  • ์˜ˆ์‹œ:
    • [Feat] Header ์ปดํฌ๋„ŒํŠธ ๊ตฌํ˜„
    • [Init] ํ”„๋กœ์ ํŠธ ์ดˆ๊ธฐ ์„ธํŒ…

Issue Template

  • ์ œ๋ชฉ: [Feat] ๊ฐ„๋‹จํ•œ ์š”์•ฝ
  • ๋‚ด์šฉ:
## ๐Ÿ“„ ์ž‘์—…ํ•  ๋‚ด์šฉ
- ์ž‘์—…ํ•  ๊ธฐ๋Šฅ์— ๋Œ€ํ•œ ์„ค๋ช…์„ ์ž‘์„ฑํ•ด์ฃผ์„ธ์š”.

## โœ… ์ž‘์—…ํ•  ๋‚ด์šฉ
- ์ž‘์—…ํ•  ๋‚ด์šฉ์„ ์ตœ๋Œ€ํ•œ ์„ธ๋ถ„ํ™” ํ•˜์—ฌ ์ž‘์„ฑํ•ด์ฃผ์„ธ์š”.
- [ ] todo
- [ ] todo

## ๐ŸŽจ ๋ทฐ ๋ฏธ๋ฆฌ๋ณด๊ธฐ
- ์ž‘์—…ํ•˜๊ณ ์ž ํ•˜๋Š” ๊ธฐ๋Šฅ์˜ ๋ทฐ๋ฅผ ์ฒจ๋ถ€ํ•ด์ฃผ์„ธ์š”.
  • ์ œ๋ชฉ: [Bug] ๊ฐ„๋‹จํ•œ ์š”์•ฝ
  • ๋‚ด์šฉ:
## ๐Ÿ› ๋ฒ„๊ทธ ์„ค๋ช…
- ๋ฒ„๊ทธ๊ฐ€ ์–ธ์ œ, ์–ด๋–ป๊ฒŒ ๋ฐœ์ƒํ–ˆ๋Š”์ง€ ์ž‘์„ฑํ•ด์ฃผ์„ธ์š”.

## ๐Ÿ‘ ์ •์ƒ ๋™์ž‘
- ์ •์ƒ์ ์ธ ๋™์ž‘์— ๋Œ€ํ•ด ์„ค๋ช…ํ•ด์ฃผ์„ธ์š”.

๐Ÿ”„ Pull Request (PR) Convention

PR Title ๊ทœ์น™

  • ํ˜•์‹: [ํƒœ๊ทธ] ์ œ๋ชฉ
  • ํƒœ๊ทธ ๋ชฉ๋ก:
    • Init: ์ดˆ๊ธฐ ์„ธํŒ…
    • Feat: ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ
    • Fix: ๋ฒ„๊ทธ ์ˆ˜์ •
    • Docs: ๋ฌธ์„œ ์ถ”๊ฐ€, ์ˆ˜์ •, ์‚ญ์ œ
    • Style: ์ฝ”๋“œ formatting, ์„ธ๋ฏธ์ฝœ๋ก  ๋ˆ„๋ฝ ๋“ฑ ์ฝ”๋“œ ์ž์ฒด ๋ณ€๊ฒฝ์ด ์—†๋Š” ์ž‘์—…
    • Refactor: ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง
    • Test: ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ž‘์„ฑ ๋ฐ ๋ฆฌํŒฉํ† ๋ง
    • Chore: ๊ธฐํƒ€ ์ž‘์—… (ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ € ์ˆ˜์ •, .gitignore ๋ณ€๊ฒฝ ๋“ฑ)
    • Build: ๋นŒ๋“œ ๊ด€๋ จ ํŒŒ์ผ ์ˆ˜์ •
    • Design: CSS ๋“ฑ ์‚ฌ์šฉ์ž UI ๋””์ž์ธ ๋ณ€๊ฒฝ
    • Comment: ์ฃผ์„ ์ถ”๊ฐ€ ๋ฐ ๋ณ€๊ฒฝ
    • Rename: ํŒŒ์ผ ๋˜๋Š” ํด๋” ์ด๋ฆ„ ๋ณ€๊ฒฝ ๋ฐ ์ด๋™
    • Remove: ํŒŒ์ผ ์‚ญ์ œ ์ž‘์—…๋งŒ ์ˆ˜ํ–‰ํ•œ ๊ฒฝ์šฐ
  • ์˜ˆ์‹œ:
    • [Feat] Header ์ปดํฌ๋„ŒํŠธ ๊ตฌํ˜„
    • [Fix] Header ์ปดํฌ๋„ŒํŠธ์˜ ๋ฒ„๊ทธ ์ˆ˜์ •

PR Template

  • PR ์ž‘์„ฑ ๊ทœ์น™:
## ๐Ÿ“‘ ์ด์Šˆ ๋ฒˆํ˜ธ
<!-- ์ด์Šˆ ๋ฒˆํ˜ธ๋ฅผ ์ž‘์„ฑํ•ด์ฃผ์„ธ์š” ex) #11 -->
- close #

## โœจ๏ธ ์ž‘์—… ๋‚ด์šฉ
<!-- ์ž‘์—… ๋‚ด์šฉ์„ ๊ฐ„๋žตํžˆ ์„ค๋ช…ํ•ด์ฃผ์„ธ์š” -->

## ๐Ÿ’™ ์ฝ”๋ฉ˜ํŠธ
<!-- ๋ฆฌ๋ทฐ์–ด๊ฐ€ ์ค‘์ ์ ์œผ๋กœ ๋ด์ฃผ์—ˆ์œผ๋ฉด ํ•˜๋Š” ๋ถ€๋ถ„์ด๋‚˜ ๊ถ๊ธˆํ•œ ์ ์„ ์ž์œ ๋กญ๊ฒŒ ๋‚จ๊ฒจ์ฃผ์„ธ์š”! -->

## ๐Ÿ“ธ ๊ตฌํ˜„ ๊ฒฐ๊ณผ
<!-- ๊ตฌํ˜„ํ•œ ๊ธฐ๋Šฅ์ด ๋ชจ๋‘ ๊ฒฐ๊ณผ๋ฌผ์— ํฌํ•จ๋˜๋„๋ก ์ž์œ ๋กญ๊ฒŒ ์ฒจ๋ถ€ํ•ด์ฃผ์„ธ์š” (์Šคํฌ๋ฆฐ์ƒท, gif, ๋™์˜์ƒ, ๋ฐฐํฌ๋งํฌ ๋“ฑ) -->

<!-- โš ๏ธโš ๏ธโš ๏ธโš ๏ธโš ๏ธโš ๏ธ ์ž ๊น !!!! โš ๏ธโš ๏ธโš ๏ธโš ๏ธโš ๏ธ -->
<!-- PR ์ œ๋ชฉ ์ปจ๋ฒค์…˜์— ๋งž๊ฒŒ ์ž˜ ์ž‘์„ฑํ–ˆ๋Š”์ง€, assignee ๋ฐ reviewer ์ง€์ •ํ–ˆ๋Š”์ง€ ๋‹ค์‹œ ํ•œ ๋ฒˆ ์ฒดํฌํ•˜๊ธฐ !! -->

๐Ÿ“‚ ํ”„๋กœ์ ํŠธ ๊ตฌ์กฐ

๐Ÿ“ฆTWC_FE
 โ”ฃ ๐Ÿ“.github
 โ”ฃ ๐Ÿ“node_modules
 โ”ฃ ๐Ÿ“public
 โ”ฃ ๐Ÿ“‚src
 โ”ƒ  โ”ฃ ๐Ÿ“‚assets
 โ”ƒ  โ”ฃ ๐Ÿ“‚components
 โ”ƒ  โ”ฃ ๐Ÿ“‚pages
 โ”ƒ  โ”ฃ ๐Ÿ“‚styles
 โ”ƒ  โ”ƒ โ”— ๐Ÿ“‚components 
 โ”ƒ  โ”ฃ ๐Ÿ“œApp.css
 โ”ƒ  โ”ฃ ๐Ÿ“œApp.jsx
 โ”ƒ  โ”ฃ ๐Ÿ“œindex.css
 โ”ƒ  โ”— ๐Ÿ“œmain.jsx
 โ”ฃ ๐Ÿ“œ.gitignore
 โ”ฃ ๐Ÿ“œeslint.config.js
 โ”ฃ ๐Ÿ“œindex.html
 โ”ฃ ๐Ÿ“œpackage-lock.json
 โ”ฃ ๐Ÿ“œpackage.json
 โ”ฃ ๐Ÿ“œREADME.md
 โ”— ๐Ÿ“œvite.config.js

About

[๐Ÿ†์ฝ”๋“œ์ž‡๋ถ€์ŠคํŠธ ํŒŒ์›Œ๋ถ€์ŠคํŠธ ๋ฐ๋ชจ๋ฐ์ด ์ธ๊ธฐ์ƒ] TWC

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors