11# :bento : typescript-nuxtjs-boilerplate
22
3- [ https://typescript-nuxtjs-boilerplate.netlify.com/example ] ( https://typescript-nuxtjs-boilerplate.netlify.com/example )
3+ example url: [ https://typescript-nuxtjs-boilerplate.netlify.com/example ] ( https://typescript-nuxtjs-boilerplate.netlify.com/example )
44
55---
66
7- ## Installation Dependencies
7+ ## Install
8+
9+ ** Note: requires node version >= 8.10.0 and npm version >= 5.6.0**
10+
11+ ### Install yarn
12+
13+ ** for mac**
14+
15+ ``` bash
16+ $ brew install yarn
17+ ```
18+
19+ ** for windows**
20+
21+ [ Use installer] ( https://yarnpkg.com/lang/en/docs/install/#windows-tab )
22+
23+ ### Install dependencies
824
925Using yarn:
1026
@@ -18,52 +34,59 @@ Using npm:
1834npm install
1935```
2036
21- ## serve with hot reload at localhost:4000
37+ ## Serve with hot reload at localhost:4000
2238
2339``` bash
2440$ yarn run dev
2541```
2642
27- and run mock server
43+ ``` bash
44+ $ yarn run local
45+ ```
46+
47+ and run mock server for examples
2848
2949``` bash
3050$ node ./tools/server.js
3151```
3252
33- ## build for production and launch server
53+ ## Build for production on docker and launch server
3454
3555``` bash
36- $ yarn run build
56+ $ yarn run build:docker
3757$ yarn start
3858```
3959
4060For detailed explanation on how things work, checkout [ Nuxt.js docs] ( https://nuxtjs.org ) .
4161
42- ## :blue_book : Example Links
62+ ## :blue_book : Example Links
4363
44- - [ root- example] ( https://typescript-nuxtjs-boilerplate.netlify.com/example )
64+ - [ / example root directory ] ( https://typescript-nuxtjs-boilerplate.netlify.com/example )
4565- [ sign-in] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/auth/sign-in )
4666- [ sign-out] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/auth/sign-out )
47- - [ ajax/ color] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/ajax/color )
48- - [ ajax/ schema] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/ajax/schema )
49- - [ custom- http- headers] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/ajax/custom-http-headers )
50- - [ custom- path] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/c-01/e-02/ )
51- - [ custom- path] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/d-03/f-04/ )
52- - [ assets- and- static] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/assets-and-static )
53- - [ todos ] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/todos )
54- - [ life- cycle] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/life-cycle )
55- - [ use- plugin] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/use-plugin )
56- - [ custom- head] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/custom-head )
57- - [ async- custom- head] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/async-custom-head )
58- - [ api] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/api )
59- - [ search/ _ condition ] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/search/?hoge=foo&bar=fuga )
60- - [ img- lazy- load] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/img-lazy-load )
61- - [ type- safe- vuex] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/type-safe-vuex )
62- - [ extend- css- class] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/extend-css-class )
63- - [ external- include] ( https://typescript-nuxtjs-boilerplate.netlify.com/include/ )
64- - [ dynamic- import] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/dynamic-import )
65- - [ user- agent] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/user-agent )
67+ - [ ajax color(pattern1) ] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/ajax/color )
68+ - [ ajax schema(pattern2) ] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/ajax/schema )
69+ - [ post custom http headers] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/ajax/custom-http-headers )
70+ - [ routing custom path(pattern1) ] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/c-01/e-02/ )
71+ - [ routing custom path(pattern2) ] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/d-03/f-04/ )
72+ - [ assets and static] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/assets-and-static )
73+ - [ basic todo example ] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/todos )
74+ - [ vue life cycle] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/life-cycle )
75+ - [ use plugin] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/use-plugin )
76+ - [ custom head tag ] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/custom-head )
77+ - [ async custom head tag ] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/async-custom-head )
78+ - [ send api in vuex ] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/api )
79+ - [ get parameters ] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/search/?hoge=foo&bar=fuga )
80+ - [ image lazy load] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/img-lazy-load )
81+ - [ type safe vuex] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/type-safe-vuex )
82+ - [ extend css class] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/extend-css-class )
83+ - [ external include file ] ( https://typescript-nuxtjs-boilerplate.netlify.com/include/ )
84+ - [ dynamic import] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/dynamic-import )
85+ - [ using user agent on ssr and csr ] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/user-agent )
6686- [ i18n] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/i18n )
87+ - [ animation - animejs] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/animejs )
88+ - [ now utc offset] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/now-utcoffset )
89+ - [ vue-carousel] ( https://typescript-nuxtjs-boilerplate.netlify.com/example/vue-carousel )
6790
6891## Maintainers
6992
0 commit comments