Skip to content

typescript-nuxtjs-boilerplate/typescript-nuxtjs-boilerplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

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

Repository files navigation

๐Ÿฑ typescript-nuxtjs-boilerplate

typescript-nuxtjs-boilerplate ใฏ Nuxt.js ใง TypeScript ใ‚’ไฝฟใ†ใŸใ‚ใฎใƒœใ‚คใƒฉใƒผใƒ—ใƒฌใƒผใƒˆใซใชใ‚Šใพใ™ ๐Ÿฆ‘

Example url: https://typescript-nuxtjs-boilerplate.netlify.com/example


โ›‘ Requirements

  • Node.js v10+ ใŠใ™ใ™ใ‚ใฏ v10.16.0 ใงใ™

๐Ÿ’พ Install

First, clone the repo via git:

git submodule ใงใ‚ตใƒณใƒ—ใƒซใ‚’ๆ›ธใ„ใฆใ„ใ‚‹ใฎใงใ€ไปฅไธ‹ใฎใ‚ˆใ†ใซ git clone ใ—ใฆใใ ใ•ใ„

$ git clone --recursive [email protected]:typescript-nuxtjs-boilerplate/typescript-nuxtjs-boilerplate.git

Install yarn

for mac

$ brew install yarn

for windows

# for Windows (with Chocolatey)
$ choco install yarn

Use installer

Install dependencies

Using yarn:

yarn install

๐Ÿ”Œ Serve with hot reload at localhost:4000

Nuxt ใฎใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฎใƒใƒผใƒˆใฏ 3000 ใงใ™ใŒใ€ไป–ใฎใƒ—ใƒญใ‚ปใ‚นใซใƒใƒƒใƒ†ใ‚ฃใƒณใ‚ฐใ™ใ‚‹ใ‚ฑใƒผใ‚นใŒๅคšใ„ใฎใงใ€ 4000 ใซใ—ใฆใ„ใพใ™

$ yarn run dev

or

local ใฏ dev ใฎใ‚จใ‚คใƒชใ‚ขใ‚นใงใ™

$ yarn run local

and run mock server for examples

ใใ—ใฆใƒขใƒƒใ‚ฏใ‚ตใƒผใƒใƒผใ‚‚ๅˆฅใฎใƒ—ใƒญใ‚ปใ‚นใจใ—ใฆ่ตทๅ‹•ใ•ใ›ใพใ™

$ node ./tools/server.js

5000 ็•ชใƒใƒผใƒˆใง่ตทๅ‹•ใ—ใพใ™

๐Ÿ•น Build for production on docker and launch server

ๆœฌ็•ช็”จใฎ docker ใƒ“ใƒซใƒ‰ใฏไปฅไธ‹ใซใชใ‚Šใพใ™

$ yarn run build:docker
$ yarn start

๐Ÿ’ป Build for production and SPA mode

$ yarn run build:static

It will be published in the dist directory

For detailed explanation on how things work, checkout Nuxt.js docs.

๐Ÿ“˜ Example Links

ใ‚ตใƒณใƒ—ใƒซ้›† - typescript-nuxtjs-boilerplate-docs

๐Ÿ–ฅ npm-scripts

npm scriptsใฎ่งฃ่ชฌ - typescript-nuxtjs-boilerplate-docs

๐Ÿ“š Docs

typescript-nuxtjs-boilerplate ใฎใƒ‰ใ‚ญใƒฅใƒกใƒณใƒˆใงใ™ docs and guides here

โš™๏ธ Maintainers

๐Ÿœ License

MIT ยฉ hisasann

twitter