Skip to content

AhaOfficial/nuxt-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation


๐Ÿ“ฎ ๋„‰์ŠคํŠธ ํ‹€ ๋ฒ„์ „: 2020-Apeach-1.0.0

๐Ÿ“ฆ ๋„‰์ŠคํŠธ ํ‹€ (nuxt-template)

๋„‰์ŠคํŠธ(Nuxt) ๋ฅผ ์‚ฌ์šฉํ•˜๊ธฐ ์ข‹๊ฒŒํ•˜๋ฉด์„œ ๊ฐ€๋Šฅํ•œ ๊ฐ€์žฅ ์ตœ์‹ ์˜ ๋ชจ๋“ˆ ๋ฒ„์ „์œผ๋กœ ๊ด€๋ฆฌํ•˜๊ณ  ์žˆ๋Š” ์˜ˆ์‹œ ํ‹€์ž…๋‹ˆ๋‹ค.

์ด ๋ฌธ์„œ์™€ ํ‹€์€ ์˜ค์ง ํ•œ๊ตญ์–ด๋กœ ํ•œ๊ตญ ๋‚ด ๋„‰์ŠคํŠธ ์ด์šฉ์ž๋ฅผ ์œ„ํ•ด ๊ตฌ์„ฑ & ๊ด€๋ฆฌ๋˜๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค.๐Ÿ˜Š (This document and template are organized and managed only for Nuxt users in Korea.)


์ด ํ”„๋กœ์ ํŠธ๋Š” ๋‹ค๋ฅธ ํ”„๋กœ์ ํŠธ๋ฅผ ๊ฐœ๋ฐœํ•  ๋•Œ ์‚ฌ์šฉํ•˜๊ธฐ ์ข‹๋„๋ก ๊ฐ€๋Šฅํ•œ ๋นˆ ํ‹€์„ ๋งŒ๋“ค๋˜ ์„ค์ •๋“ค๊ณผ ๊ตฌ์กฐ๋“ค์„ ์žก์•„๋†“๋Š” ํ”„๋กœ์ ํŠธ๋กœ ์ œํ•œ๋œ ์ผ๋ถ€ ์˜ˆ์‹œ๋งŒ์„ ๊ฐ€์ง€๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค. ๐Ÿค—


๐Ÿฅณ ๋ฌธ์„œ ๋ชจ์Œ

๋ฌธ์„œ๋ฅผ ๊ธฐ์—ฌํ•ด์ฃผ์‹œ๋ ค๋ฉด docs/ ์— md ํŒŒ์ผ์„ ์ž‘์„ฑํ•ด์ฃผ์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค! [์ž‘์„ฑ๋ฐฉ๋ฒ•]


๐Ÿ”ฎ ๋ธŒ๋ผ์šฐ์ € ์ƒ์—์„œ ์‹คํ–‰ ๋ฐฉ๋ฒ•

ํ”„๋กœ์ ํŠธ๋ฅผ ์›น์—์„œ ๋ฐ”๋กœ ์‹คํ–‰์‹œํ‚ค๊ฑฐ๋‚˜, ์•„๋‹ˆ๋ฉด ๊ฐ€๋ณ๊ฒŒ ์‹œํ—˜ ๊ฐœ๋ฐœ์„ ์ง„ํ–‰ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.


๐Ÿ”ฎ ๊ฐ€๋ฒผ์šด ์‹œํ—˜๊ฐœ๋ฐœ์šฉ

์ฝ”๋“œํŽœ์ด๋ผ๋Š” ์›น ์—๋””ํ„ฐ๋ฅผ ํ†ตํ•ด์„œ ์ด ํ”„๋กœ์ ํŠธ ํ‹€์„ ์‚ฌ์šฉํ•˜๋ฉด์„œ ๊ฐ€๋ณ๊ฒŒ ํ•œ ํŽ˜์ด์ง€๋ฅผ ์ž‘์„ฑํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

๊ฐ„๋‹จํ•œ ์˜ˆ์‹œ๋ฅผ ๋งŒ๋“ค์–ด์„œ ๊ณต์œ ํ•˜๊ฑฐ๋‚˜, ์–ด๋– ํ•œ ์ฝ”๋“œ๊ฐ€ ์ž‘๋™ํ• ์ง€ ๊ฐ„๋‹จํžˆ ์‹œํ—˜ ๊ฐœ๋ฐœํ•ด๋ณด๋Š”๋ฐ์— ์šฉ์ดํ•ฉ๋‹ˆ๋‹ค.


๐Ÿ”ฎ ํ”„๋กœ์ ํŠธ๋ฅผ ์›น์—์„œ ์‹คํ–‰

์ฝ”๋“œ ์ƒŒ๋“œ๋ฐ•์Šค๋ผ๋Š” ์›น IDE ๋ฅผ ํ†ตํ•ด์„œ ์ด ํ”„๋กœ์ ํŠธ๋ฅผ ์„ค์น˜ ์—†์ด ์›น์—์„œ ๋ฐ”๋กœ ์‹คํ–‰ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

์›น ์ƒ ๋นŒ๋“œ์— 2๋ถ„ ๊ฐ€๋Ÿ‰ ์‹œ๊ฐ„์ด ์†Œ์š”๋˜๋ฉฐ, ๋นŒ๋“œ๊ฐ€ ์™„๋ฃŒ๋˜๋ฉด ๋‚ด๋ถ€ ๋ธŒ๋ผ์šฐ์ €๊ฐ€ ๋ฐ”๋กœ ์‹คํ–‰๋ฉ๋‹ˆ๋‹ค.

๐Ÿš€ CodeSandbox ์›น IDE ์‹คํ–‰ [์‹คํ–‰๋ชจ์Šต ์ด๋ฏธ์ง€]


โš—๏ธ ํ”„๋กœ์ ํŠธ ์ƒ์„ฑ๋ฐฉ๋ฒ•

์ด ํ…œํ”Œ๋ฆฟ์„ ์ด์šฉํ•œ ํ”„๋กœ์ ํŠธ๋ฅผ ๋กœ์ปฌ์— ์ƒ์„ฑํ•˜๋ ค๋ฉด ๋‹ค์Œ ๋ช…๋ น์–ด๋ฅผ ์ž…๋ ฅํ•˜์„ธ์š”.

npx degit AhaOfficial/nuxt-template <ํ”„๋กœ์ ํŠธ๋ช…>
cd <ํ”„๋กœ์ ํŠธ๋ช…>

๋˜๋Š” ์›ํ•˜๋Š” ํด๋” ์•ˆ์— ๋ฐ”๋กœ ํ”„๋กœ์ ํŠธ๋ฅผ ์ƒ์„ฑํ•˜๋ ค๋ฉด ๋‹ค์Œ ๋ช…๋ น์–ด๋ฅผ ์ž…๋ ฅํ•˜์„ธ์š”.

npx degit AhaOfficial/nuxt-template

๐ŸŽ› ์ตœ์ƒ์œ„ ํด๋”/ํŒŒ์ผ ์„ค๋ช…

ํด๋” ๋ฐ ํŒŒ์ผ์— ๋Œ€ํ•œ ์„ค๋ช…์ด ์—ฌ๊ธฐ ๋‹ด๊น๋‹ˆ๋‹ค.

  • ๐Ÿ—‚ .nuxt

    ํด๋ผ์ด์–ธํŠธ ํ”„๋กœ๊ทธ๋žจ์ด ๋นŒ๋“œ๋œ ๊ฒฐ๊ณผ๋ฌผ๊ณผ ๊ทธ์— ํ•„์š”ํ•œ ๋ฐ”๋กœ ์‹คํ–‰๊ฐ€๋Šฅํ•œ ์„œ๋ฒ„ ํ”„๋กœ๊ทธ๋žจ์ด ๋‹ด๊น๋‹ˆ๋‹ค.

    (์ด ํด๋”๋Š” ๋นŒ๋“œ๊ฐ€ ์™„๋ฃŒ๋œ ์ดํ›„ ์‹œ์ ์— ์ƒ์„ฑ๋ฉ๋‹ˆ๋‹ค. ์‚ญ์ œํ•ด๋„ ๋งค ๋นŒ๋“œ๋งˆ๋‹ค ์žฌ์ƒ์„ฑ ๋ฉ๋‹ˆ๋‹ค.)

  • ๐Ÿ—‚ .vscode

    VSCode ํŽธ์ง‘๊ธฐ ์‚ฌ์šฉ์‹œ ๊ณตํ†ต์ ์œผ๋กœ ์‚ฌ์šฉ๋  ํŽธ์ง‘ ๊ทœ์น™๋“ค์ด ์—ฌ๊ธฐ์— ์ •์˜๋ฉ๋‹ˆ๋‹ค.

  • ๐Ÿ—‚ src

    ํด๋ผ์ด์–ธํŠธ ํ”„๋กœ๊ทธ๋žจ์˜ ์—์…‹(์†Œ์Šค์ฝ”๋“œ๋“ค๊ณผ ๋ฆฌ์†Œ์Šค)๋“ค์ด ๋ชจ๋‘ ์—ฌ๊ธฐ์— ๋‹ด๊น๋‹ˆ๋‹ค.

  • ๐Ÿ—‚ docs

    ์ด ํ”„๋กœ์ ํŠธ์™€ ๊ด€๋ จ๋œ ๋ฌธ์„œ๋“ค์ด ์—ฌ๊ธฐ์— ๋‹ด๊น๋‹ˆ๋‹ค.

  • ๐Ÿ—‚ node_modules

    ํ”„๋กœ์ ํŠธ์—์„œ ์‚ฌ์šฉํ•˜๋Š”๋…ธ๋“œ ๋ชจ๋“ˆ๋“ค์ด ์—ฌ๊ธฐ์— ๋‹ค์šด๋กœ๋“œ ๋ฉ๋‹ˆ๋‹ค.

    (์ด ํด๋”๋Š” npm install ๋ช…๋ น์–ด๊ฐ€ ์‹คํ–‰๋œ ์‹œ์ ์— ์ƒ์„ฑ๋ฉ๋‹ˆ๋‹ค. ์‚ญ์ œํ•ด๋„ ๋งค ์„ค์น˜๋งˆ๋‹ค ์žฌ์ƒ์„ฑ๋ฉ๋‹ˆ๋‹ค.)

  • ๐Ÿ“ .eslintignore

    ESLint ์—์„œ ๋ฆฐํŠธ ์ ์šฉ์‹œ ๋ฐฐ์ œํ•  ๋Œ€์ƒ ๊ทœ์น™์ด ์—ฌ๊ธฐ์— ๋‹ด๊น๋‹ˆ๋‹ค.

  • ๐Ÿ“ .eslintrc.js

    ESLint ์—์„œ ์‚ฌ์šฉํ•  ์ž๋™์ •๋ ฌ ๊ทœ์น™์ด ์—ฌ๊ธฐ์— ๋‹ด๊น๋‹ˆ๋‹ค.

  • ๐Ÿ“ .gitignore

    Git ์ž๋™์œผ๋กœ ์—…๋กœ๋“œ๋˜์ง€ ์•Š์„ ํŒŒ์ผ๊ณผ ํด๋” ๋ชฉ๋ก ๊ทœ์น™์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค.

  • ๐Ÿ“ .prettierrc.json

    Prettier ์—์„œ ์‚ฌ์šฉํ•  ์ž๋™์ •๋ ฌ ๊ทœ์น™์ด ์—ฌ๊ธฐ์— ๋‹ด๊น๋‹ˆ๋‹ค.

    (ํ˜„์žฌ ์ด ํ”„๋กœ์ ํŠธ๋Š” ์ž๋™์ •๋ ฌ์— ESLint ์™€ Prettier ๋ฅผ ๋ชจ๋‘ ์‚ฌ์šฉํ•˜๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค.)

  • ๐Ÿ“ LICENSE

    ์ด ํŒŒ์ผ์—” ์ด ํ”„๋กœ์ ํŠธ์˜ ๊ธฐ๋ณธ ์ €์ž‘๊ถŒ ์ •๋ณด๊ฐ€ ๋‹ด๊น๋‹ˆ๋‹ค.

    (์ด ํ…œํ”Œ๋ฆฟ์„ ์ด์šฉํ•ด ์ƒˆ ํ”„๋กœ์ ํŠธ๋ฅผ ๋งŒ๋“ค ๋•Œ์—๋Š” LICENSE.md ๋ฅผ ์•Œ๋งž๊ฒŒ ์ˆ˜์ •ํ•˜์…”์•ผ ํ•ฉ๋‹ˆ๋‹ค.)

  • ๐Ÿ“ nuxt.config.ts

    ๋„‰์ŠคํŠธ ํ”„๋กœ์ ํŠธ์˜ ์„ค์ • ์ •๋ณด๊ฐ€ ์—ฌ๊ธฐ์— ๋‹ด๊น๋‹ˆ๋‹ค.

  • ๐Ÿ“ package.json

    ์ด ํ”„๋กœ์ ํŠธ์—์„œ ์‚ฌ์šฉํ•˜๋Š” ๋ชจ๋“ˆ๋“ค์ด ์—ฌ๊ธฐ์— ๋ช…์‹œ๋ฉ๋‹ˆ๋‹ค.

  • ๐Ÿ“ package-lock.json

    ์ด ํ”„๋กœ์ ํŠธ์—์„œ ์‚ฌ์šฉํ•˜๋Š” ๋ชจ๋“ˆ๋“ค์˜ ๋‹ค์šด๋กœ๋“œ ๊ฒฝ๋กœ์™€ ๋งˆ์ง€๋ง‰์œผ๋กœ ์‚ฌ์šฉํ•œ ๋ชจ๋“ˆ ๋ฒ„์ „์ด ๊ธฐ๋ก๋ฉ๋‹ˆ๋‹ค.

    (ํ”„๋กœ์ ํŠธ์—์„œ ์‚ฌ์šฉํ•˜๋Š” ๋ชจ๋“ˆ๊ด€๊ณ„๋ฅผ ํ™•์ธํ•  ๋•Œ์— ์ค‘์š”ํ•œ ํŒŒ์ผ์ด๋‚˜, ์‚ญ์ œ์‹œ ์žฌ์ƒ์„ฑ์ด ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.)

  • ๐Ÿ“ postbuild.ts

    nuxt ์˜ transpile ๋ชจ๋“ˆ ๋Œ€์ƒ์„ ์ž๋™์œผ๋กœ ๋ช…์‹œํ•ด์ฃผ๋Š” ํ•จ์ˆ˜๊ฐ€ ๋‹ด๊ฒจ์žˆ์Šต๋‹ˆ๋‹ค.

  • ๐Ÿ“ qawolf.config.ts

    QAWolf ์˜ ์„ค์ •์ด ์—ฌ๊ธฐ์— ๋‹ด๊น๋‹ˆ๋‹ค.

  • ๐Ÿ“ README.md

    ์ด ํ”„๋กœ์ ํŠธ๋ฅผ ์„ค๋ช…ํ•˜๋Š” Markdown ํ˜•ํƒœ์˜ ๋ฌธ์„œ์ž…๋‹ˆ๋‹ค.

    (README.md ๋ฅผ ์ˆ˜์ •ํ•  ๋•Œ์—” Typora ๋ผ๋Š” ์—๋””ํ„ฐ๋ฅผ ์ถ”์ฒœํ•ฉ๋‹ˆ๋‹ค.)

  • ๐Ÿ“ sandbox.config.json

    ํด๋ผ์šฐ๋“œ IDE ์„ค์ •ํŒŒ์ผ ์ž…๋‹ˆ๋‹ค. ์›น์—์„œ Codesandbox ๋‚˜ Github IDE ๋ฅผ ํ†ตํ•ด์„œ ๋ฐ”๋กœ ํŽธ์ง‘ ๋ฐ ์‹คํ–‰์ด ๋  ๋•Œ์—, ์ด ํ”„๋กœ์ ํŠธ๋Š” node ๋ฅผ ๊ธฐ๋ฐ˜์œผ๋กœ ํ•˜๋Š” ํ”„๋กœ์ ํŠธ๋ผ๋Š” ๊ฒƒ์„ ์•Œ๋ฆฝ๋‹ˆ๋‹ค. [์„ค๋ช…๋ฌธ์„œ]

  • ๐Ÿ“ stylelint.config.js

  • ๐Ÿ“ tsconfig.json

    ์ด ํ”„๋กœ์ ํŠธ์—์„œ ์‚ฌ์šฉํ•˜๋Š” ํƒ€์ž…์Šคํฌ๋ฆฝํŠธ ์„ค์ •์ด ์—ฌ๊ธฐ์— ๋ช…์‹œ๋ฉ๋‹ˆ๋‹ค.



๐Ÿท ์ €์ž‘๊ถŒ

MIT Licensed.