Skip to content

cocos-pet/cocos-frontend

Repository files navigation

ํŒŒ๋น„์ฝ˜ ์ฝ”์ฝ”์Šค

image ๋ฐ˜๋ ค๋™๋ฌผ ์ฆ์ƒ์„ ๊ฒช๋Š” ๋ฐ˜๋ ค์ธ๋“ค์ด ์ปค๋ฎค๋‹ˆํ‹ฐ๋ฅผ ํ†ตํ•ด ๊ณ ๋ฏผ์„ ๊ณต์œ ํ•˜๊ณ  ๋ณ‘์› ์ •๋ณด๋ฅผ ํ™•์ธํ•  ์ˆ˜ ์žˆ๋Š” ์„œ๋น„์Šค!


๐Ÿถ COCOS Team

ํ”„๋กœํ•„์‚ฌ์ง„
๐ŸŽง๊ณต์ค€ํ˜
ํ”„๋กœํ•„์‚ฌ์ง„
๐ŸŒธ๊น€๋ฏผ์ •
ํ”„๋กœํ•„์‚ฌ์ง„
๐Ÿถ์ด์˜ˆ๋ฆผ
ํ”„๋กœํ•„์‚ฌ์ง„
๐Ÿพ์ด์œค์ง€
Lead, ๋งˆ์ดํŽ˜์ด์ง€ ๋ทฐ
๊ฒ€์ƒ‰, ๊ฒŒ์‹œ๋ฌผ ๋ทฐ
๋กœ๊ทธ์ธ, ์˜จ๋ณด๋”ฉ ๋ทฐ
๋ฉ”์ธ, ์ปค๋ฎค๋‹ˆํ‹ฐ ๋ทฐ

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

์—ญํ•  ์ข…๋ฅ˜ ์„ ์ • ์ด์œ 
Library React ์ปดํฌ๋„ŒํŠธ ๊ธฐ๋ฐ˜ ๊ฐœ๋ฐœ๋กœ ์œ ์ง€๋ณด์ˆ˜์„ฑ๊ณผ ์žฌ์‚ฌ์šฉ์„ฑ์„ ๋†’์ด๊ธฐ ์œ„ํ•ด ์„ ์ •
Programming Language TypeScript ์ฝ”๋“œ ์•ˆ์ •์„ฑ๊ณผ ์ƒ์‚ฐ์„ฑ์„ ๋™์‹œ์— ํ™•๋ณดํ•˜๊ธฐ ์œ„ํ•ด ์‚ฌ์šฉ
Styling Vanila Extract ํƒ€์ž… ์•ˆ์ „์„ฑ๊ณผ ๋ชจ๋“ˆํ™”๋œ ์Šคํƒ€์ผ๋ง์„ ์ œ๊ณตํ•˜์—ฌ ์œ ์ง€๋ณด์ˆ˜์„ฑ์„ ๊ฐ•ํ™”
Data Fetching Tanstack-Query ๋ฐ์ดํ„ฐ ํŒจ์นญ๊ณผ ์บ์‹ฑ์„ ํšจ์œจ์ ์œผ๋กœ ๊ด€๋ฆฌํ•˜๊ณ  ๊ฐ„ํŽธํ•˜๊ฒŒ ์„œ๋ฒ„ ์ƒํƒœ๋ฅผ ๋™๊ธฐํ™”ํ•˜๊ธฐ ์œ„ํ•ด ์‚ฌ์šฉ
State Management Zustand ๊ฐ„๊ฒฐํ•˜๊ณ  ์œ ์—ฐํ•œ ์ƒํƒœ ๊ด€๋ฆฌ๋กœ ์ง๊ด€์ ์ธ ๋กœ์ง ๊ตฌํ˜„์„ ์ง€์›
Formatting biome ์ฝ”๋“œ ํฌ๋งทํŒ…๊ณผ ๋ฆฐํŒ…์„ ํ†ตํ•ฉ ๊ด€๋ฆฌํ•ด ์ผ๊ด€๋œ ์ฝ”๋“œ ์Šคํƒ€์ผ ์œ ์ง€
Package Manager Pnpm ๋น ๋ฅธ ์†๋„์™€ ๋””์Šคํฌ ๊ณต๊ฐ„ ์ ˆ์•ฝ์„ ์ œ๊ณตํ•˜๋Š” ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ €๋กœ ํ”„๋กœ์ ํŠธ ํšจ์œจ์„ฑ์„ ๊ทน๋Œ€ํ™”
Version Control Git GitHub ๋ฒ„์ „ ๊ด€๋ฆฌ๋ฅผ ํ†ตํ•ด ํ˜‘์—…์„ ์›ํ™œํžˆ ํ•˜๊ณ  ์ฝ”๋“œ ๋ณ€๊ฒฝ ์ด๋ ฅ์„ ์ฒด๊ณ„์ ์œผ๋กœ ๊ด€๋ฆฌ
Deployment Vercel ์‰ฌ์šด ๋ฐฐํฌ์™€ ๊ธ€๋กœ๋ฒŒ CDN์„ ํ†ตํ•ด ๋น ๋ฅด๊ณ  ์•ˆ์ •์ ์ธ ์‚ฌ์šฉ์ž ๊ฒฝํ—˜ ์ œ๊ณต

๐Ÿ“„ ์ปจ๋ฒค์…˜ ๋ฐ ๋ธŒ๋žœ์น˜ ์ „๋žต (Git, Branch)

Git Branch

- main (๋ฐฐํฌ์šฉ)
- develop (๊ฐœ๋ฐœ์šฉ)
- feat/#issue/๊ธฐ๋Šฅ๋ช… (์ž‘์—…์šฉ)

Commit Convention

Commit Message ๐Ÿ‘‰ ๊ธฐ๋Šฅ ํ‚ค์›Œ๋“œ: ์ปค๋ฐ‹ ๋‚ด์šฉ

Commit Type Description
โœจ feat ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€
๐Ÿš€ api api ์—ฐ๋™
๐Ÿž fix ๋ฒ„๊ทธ ์ˆ˜์ •
๐Ÿ“ฆ chore ๋นŒ๋“œ ์—…๋ฌด, ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ €, ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ, dependencies ์„ค์ •
๐Ÿ“ docs ๋ฌธ์„œ ์ˆ˜์ • - ex) README.md
๐ŸŽจ design ์‚ฌ์šฉ์ž UI ๋””์ž์ธ ๋ณ€๊ฒฝ - ex) CSS
๐Ÿ’„ style ๊ธฐ๋Šฅ ์ˆ˜์ • ์—†๋Š” ์ฝ”๋“œ ์Šคํƒ€์ผ ๋ณ€๊ฒฝ
โ™ป๏ธ refactor ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง
๐Ÿ“ test ํ…Œ์ŠคํŠธ ์ฝ”๋“œ, ๋ฆฌํŒฉํ† ๋ง ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€
๐ŸŒ ci ci ์„ค์ • ํŒŒ์ผ ์ˆ˜์ •
๐Ÿช„ perf ์„ฑ๋Šฅ ๊ฐœ์„ 
๐Ÿ› ๏ธ rename ํŒŒ์ผ ํ˜น์€ ํด๋”๋ช… ๋ณ€๊ฒฝ
โš™๏ธ init ์ดˆ๊ธฐ ์„ธํŒ…

Coding Convention

COCOS Web์˜ ์ฝ”๋”ฉ ์ปจ๋ฒค์…˜

PR & Issue Template

์ด์Šˆ ๋ฐ pr ํ…œํ”Œ๋ฆฟ์€ ์‹ค์ œ๋กœ ์ด์Šˆ์™€ PR์ด ์˜ฌ๋ผ์˜ค๋Š” ํ…œํ”Œ๋ฆฟ ํ™•์ธ!


๐Ÿ“ท ๊ตฌํ˜„ ๋ทฐ

ํŒŒ๋น„์ฝ˜



๐Ÿ“ ํด๋” ๊ตฌ์กฐ

๐Ÿ“ฆ public
๐Ÿ“ฆ src
 โ”ฃ ๐Ÿ“‚asset
 โ”ƒ โ”ฃ ๐Ÿ“‚svg
 โ”ƒ โ”— ๐Ÿ“‚image
 โ”ฃ ๐Ÿ“‚api
 โ”ƒ โ”ฃ ๐Ÿ“‚domain
 โ”ƒ โ”ฃ ๐Ÿ“‚kakaologin
 โ”ƒ โ”— ๐Ÿ“œindex.tsx
 โ”ฃ ๐Ÿ“‚common
 โ”ƒ โ”ฃ ๐Ÿ“‚component
 โ”ƒ โ”ฃ ๐Ÿ“‚util
 โ”ƒ โ”ฃ ๐Ÿ“‚hook
 โ”ƒ โ”— ๐Ÿ“‚service
 โ”ฃ ๐Ÿ“‚shared
 โ”ƒ โ”ฃ ๐Ÿ“‚component
 โ”ƒ โ”ฃ ๐Ÿ“‚util
 โ”ƒ โ”ฃ ๐Ÿ“‚hook
 โ”ƒ โ”ฃ ๐Ÿ“‚storage
 โ”ƒ โ”ฃ ๐Ÿ“‚store
 โ”ƒ โ”ฃ ๐Ÿ“‚constant
 โ”ƒ โ”— ๐Ÿ“‚style
 โ”ฃ ๐Ÿ“‚page
 โ”ƒ โ”ฃ ๐Ÿ“‚main
 โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚user
 โ”ƒ โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚component
 โ”ƒ โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚constant
 โ”ƒ โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚type
 โ”ƒ โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚hook
 โ”ƒ โ”ƒ โ”ƒ โ”— ๐Ÿ“‚util
 โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚shared
 โ”ƒ โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚component
 โ”ƒ โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚constant
 โ”ƒ โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚hook
 โ”ƒ โ”ƒ โ”ƒ โ”— ๐Ÿ“‚util
 โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚index
 โ”ƒ โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚component
 โ”ƒ โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚constant
 โ”ƒ โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚type
 โ”ƒ โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚hook
 โ”ƒ โ”ƒ โ”ƒ โ”— ๐Ÿ“‚util
 โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“œpage.tsx
 โ”ƒ โ”ƒ โ”— ๐Ÿ“œPage.styled.ts
 โ”ƒ โ”ฃ ๐Ÿ“‚admin
 โ”ƒ โ”— ๐Ÿ“‚mypage
 โ”ฃ ๐Ÿ“‚style
 โ”ƒ โ”ฃ ๐Ÿ“œGlobalStyles.ts
 โ”ƒ โ”— ๐Ÿ“œtheme.ts
 โ”ฃ ๐Ÿ“‚type
 โ”ƒ โ”— ๐Ÿ“œglobal.d.ts
 โ”ฃ ๐Ÿ“‚route
 โ”ƒ โ”— ๐Ÿ“œRouter.tsx
 โ”ฃ ๐Ÿ“œApp.tsx
 โ”ฃ ๐Ÿ“œmain.tsx
 โ”ฃ ๐Ÿ“œeslint.config.js
 โ”ฃ ๐Ÿ“œ.gitignore
 โ”ฃ ๐Ÿ“œ.prettierrc.json
 โ”ฃ ๐Ÿ“œ.stylelintrc.json
 โ”ฃ ๐Ÿ“œREADME.md
 โ”ฃ ๐Ÿ“œpackage.json
 โ”ฃ ๐Ÿ“œtsconfig.json
 โ”— ๐Ÿ“œyarn.lock

About

๐Ÿพ COCOS ์›น ๋ ˆํฌ์ง€ํ† ๋ฆฌ ๐Ÿพ

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •