:bento: 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
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.
:blue_book: 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