Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

road-maker/road-maker-react-typescript

Repository files navigation

RoadMaker

๋กœ๋“œ๋ฉ”์ด์ปค๋Š” ๋ˆ„๊ตฌ๋‚˜ ํ•™์Šต ๋กœ๋“œ๋งต์„ ๋งŒ๋“ค๊ณ , ๊ณต์œ ํ•  ์ˆ˜ ์žˆ๋Š” ํ”Œ๋žซํผ ์ž…๋‹ˆ๋‹ค. ํ˜„์žฌ ์ „์ฒด ๋ฆฌํŒฉํ† ๋ง ๊ณผ์ •์ค‘์— ์žˆ์Šต๋‹ˆ๋‹ค.

image

๋ณธ ๋ฌธ์„œ๋Š” RoadMaker์˜ ํ”„๋ก ํŠธ์—”๋“œ์— ์ดˆ์ ์„ ๋งž์ถฐ ์ž‘์„ฑ๋์Šต๋‹ˆ๋‹ค. ๐Ÿ‘‰ ๋ฐฑ์—”๋“œ ๋ฌธ์„œ

๋ชฉ์ฐจ

  1. ํ”„๋กœ์ ํŠธ ๊ฐœ์š”
  2. ์„œ๋น„์Šค ์†Œ๊ฐœ
  3. ํ™”๋ฉด ๊ตฌ์„ฑ
  4. ์ปค๋ฐ‹ ์ปจ๋ฒค์…˜

1. ํ”„๋กœ์ ํŠธ ๊ฐœ์š”

1.1. ๊ธฐ์ˆ  ์Šคํƒ

  • ๊ธฐ์ˆ : React, Tanstack Query, Styled components
  • ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ : dagrejs, mantine, tiptap, axios
  • ๋นŒ๋“œ, ๋ฐฐํฌ: Github Actions

1.2. ํŒ€์›

1.3. ์‹œ์—ฐ ์—ฐ์ƒ

2. ์„œ๋น„์Šค ์†Œ๊ฐœ

ํ”„๋กœ๊ทธ๋ž˜๋จธ๊ฐ€ ๋˜๊ณ  ์‹ถ์–ดํ•˜๋Š” ์‚ฌ๋žŒ๋“ค์€ "๋กœ๋“œ๋งต"์ด๋‚˜ "์ปค๋ฆฌํ˜๋Ÿผ"์ด๋ผ๋Š” ํ‚ค์›Œ๋“œ๋กœ ์ž๋ฃŒ๋ฅผ ๊ฒ€์ƒ‰ํ•ฉ๋‹ˆ๋‹ค.

์ด๋Ÿฌํ•œ ์ •๋ณด๊ฐ€ ๋ชจ์—ฌ์žˆ๋Š” "developer-roadmap" ๋ฆฌํฌ์ง€ํ† ๋ฆฌ๊ฐ€ 24๋งŒ ๊ฐœ์˜ star๋ฅผ ๋ฐ›์€ ๊ฒƒ์€ ์ด๋Ÿฌํ•œ ์ˆ˜์š”๋ฅผ ์ž˜ ๋ณด์—ฌ์ฃผ๋Š” ์˜ˆ์ž…๋‹ˆ๋‹ค.

ํ•˜์ง€๋งŒ, ๊ธฐ์กด์˜ ๋กœ๋“œ๋งต์„ ์‚ฌ์šฉํ•˜๋‹ค ๋ณด๋ฉด '๋‚˜๋„ ๋กœ๋“œ๋งต์„ ๋งŒ๋“ค์–ด๋ณด๊ณ  ์‹ถ๋‹ค๋‚ด๊ฐ€ ๋งŒ๋“  ๋กœ๋“œ๋งต์„ ๋‹ค๋ฅธ ์‚ฌ๋žŒ๊ณผ ๊ณต์œ ํ•˜๊ณ  ์‹ถ๋‹ค'๋Š” ์ƒ๊ฐ์ด ๋“ค๊ฒŒ ๋ฉ๋‹ˆ๋‹ค.

์ด๋Ÿฐ ํ•„์š”์„ฑ์— ์‘๋‹ตํ•˜์—ฌ, "RoadMaker"๋ฅผ ๊ฐœ๋ฐœํ•˜๊ฒŒ ๋˜์—ˆ์Šต๋‹ˆ๋‹ค.

RoadMaker๋Š” ์‚ฌ์šฉ์ž๊ฐ€ ์ž์‹ ๋งŒ์˜ ๊ฐœ๋ฐœ ๋กœ๋“œ๋งต์„ ์‰ฝ๊ฒŒ ๋งŒ๋“ค๊ณ  ๊ณต์œ ํ•  ์ˆ˜ ์žˆ๋Š” ํ”Œ๋žซํผ์ž…๋‹ˆ๋‹ค.

2.1. ์ฃผ์š” ๊ธฐ๋Šฅ

  1. ๋กœ๋“œ๋งต ์ž๋™ ์ƒ์„ฑ
    • GPT API๋ฅผ ์ด์šฉํ•˜์—ฌ ๋กœ๋“œ๋งต ์ดˆ์•ˆ์„ ์ž๋™ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค.
  2. ๋กœ๋“œ๋งต ์ฐธ์—ฌ ๋ฐ ์ง„ํ–‰
    • ๋กœ๋“œ๋งต์— ์ฐธ์—ฌํ•˜๊ณ  ์ง„ํ–‰๋„๋ฅผ ์—…๋ฐ์ดํŠธ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
  3. ๋Œ“๊ธ€ ์ž‘์„ฑ
    • ๋กœ๋“œ๋งต์— ๋Œ€ํ•ด ๊ถ๊ธˆํ•œ ๋‚ด์šฉ์„ ๋Œ“๊ธ€์„ ๋‹ฌ์•„ ์งˆ๋ฌธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
  4. ๊ฒ€์ƒ‰ ๊ธฐ๋Šฅ
    • ์›ํ•˜๋Š” ๋กœ๋“œ๋งต์„ ๊ฒ€์ƒ‰์„ ํ†ตํ•ด ์ฐพ์„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

3. ํ™”๋ฉด ๊ตฌ์„ฑ

  1. ๋ฉ”์ธ ํ™”๋ฉด
    • infinitescroll๋กœ ํŽ˜์ด์ง€๋ฅผ ์Šคํฌ๋กคํ•  ๊ฒฝ์šฐ ์ถ”๊ฐ€์ ์œผ๋กœ ๊ฒŒ์‹œ๋ฌผ์„ ๋ณผ ์ˆ˜ ์žˆ๋„๋ก ๊ตฌํ˜„ํ–ˆ์Šต๋‹ˆ๋‹ค.
    image
  2. ํšŒ์›์ผ ๊ฒฝ์šฐ, ํ™”๋ฉด ์šฐ์ธก ์ƒ๋‹จ [๋กœ๋“œ๋งต ์ƒ์„ฑ] ๋ฒ„ํŠผ์„ ํด๋ฆญ ์‹œ, chatgpt api๋ฅผ ํ™œ์šฉํ•ด ๋กœ๋“œ๋งต ํ…œํ”Œ๋ฆฟ์„ ์ž๋™ ์ƒ์„ฑํ•  ์ˆ˜ ์žˆ๋Š” ํ‚ค์›Œ๋“œ ์ž…๋ ฅ ๋ชจ๋‹ฌ์„ ๊ตฌํ˜„ํ–ˆ์Šต๋‹ˆ๋‹ค. image image
  3. ๋กœ๋“œ๋งต ์ƒ์„ฑ ํŽ˜์ด์ง€
    • chatgpt api๋กœ ๋กœ๋“œ๋งต ํƒฌํ”Œ๋ฆฟ์„ ์ƒ์„ฑํ•˜๊ณ ๋‚˜์‚ฌ, ๋‚ด์šฉ ์ˆ˜์ •์ด๋‚˜ ์ถ”๊ฐ€๋ฅผ ์œ„ํ•œ ์—๋””ํ„ฐ ํŽ˜์ด์ง€์ž…๋‹ˆ๋‹ค.
    image
  4. ๋กœ๋“œ๋งต ๋…ธ๋“œ์˜ ์ƒ์„ธ๋‚ด์šฉ์„ ์ˆ˜์ •ํ•  ์ˆ˜ ์žˆ๋Š” ๋ชจ๋‹ฌ
    • tiptap ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ๋ฅผ ํ™œ์šฉํ•ด ๋งˆํฌ๋‹ค์šด ๋ฌธ๋ฒ•, ์ด๋ฏธ์ง€, ๋งํฌ๋“ฑ์˜ ์ƒ์„ธ ๋‚ด์šฉ๋“ค์„ ์ˆ˜์ •ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
    image image
  5. ๋กœ๋“œ๋งต ์ƒ์„ธ ํŽ˜์ด์ง€
    • ์™„์„ฑํ•œ ๋กœ๋“œ๋งต ๊ฒŒ์‹œ๋ฌผ ํ™”๋ฉด์ž…๋‹ˆ๋‹ค. ์ƒ์„ธ ๋‚ด์šฉ์€ drawer ํ˜•ํƒœ๋กœ, ๋…ธ๋“œ๋ฅผ ํด๋ฆญ ์‹œ ํ™•์ธ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.
    • ์ง„ํ–‰์ƒํ™ฉ์„ ํด๋ฆญํ•˜๋ฉด ๋…ธ๋“œ ์ƒํƒœ๊ฐ€ ์™„๋ฃŒ ์ƒํƒœ๋กœ ๋ฐ˜์˜๋ฉ๋‹ˆ๋‹ค.
    image image
  6. ๋กœ๋“œ๋งต ๊ฒ€์ƒ‰์ฐฝ
    • ํ‚ค์›Œ๋“œ๋กœ ํŠน์ • ๋กœ๋“œ๋งต์„ ๊ฒ€์ƒ‰ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. (์˜ˆ์‹œ: ์ž๋ฐ”์Šคํฌ๋ฆฝํŠธ)
    image image
  7. ๋กœ๋“œ๋งต ๋Œ“๊ธ€ ๋ชจ๋‹ฌ image image
  8. ๋งˆ์ดํŽ˜์ด์ง€
    • ์ง„ํ–‰ ์ค‘์ธ ๋กœ๋“œ๋งต๊ณผ ๋‚ด๊ฐ€ ๋งŒ๋“  ๋กœ๋“œ๋งต์„ ํ™•์ธํ•  ์ˆ˜ ์žˆ๋Š” ํŽ˜์ด์ง€ ์ž…๋‹ˆ๋‹ค.
image image

4. ์ปค๋ฐ‹ ์ปจ๋ฒค์…˜

๋ณธ ํ”„๋กœ์ ํŠธ์—์„œ๋Š” AngularJS commit Convention์„ ์ฑ„ํƒํ–ˆ์Šต๋‹ˆ๋‹ค.

[#์ด์Šˆ ๋ฒˆํ˜ธ] ์ด์Šˆ ํƒ€์ž…: ์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€

4.1. ํƒ€์ž… ๋ชฉ๋ก

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

About

๐Ÿ“ Share and study roadmaps & create them with chatgpt-aided templates

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

Contributors

AltStyle ใซใ‚ˆใฃใฆๅค‰ๆ›ใ•ใ‚ŒใŸใƒšใƒผใ‚ธ (->ใ‚ชใƒชใ‚ธใƒŠใƒซ) /