1.0.2 • Published 2 years ago

nuxt2-storybook-ts v1.0.2

Weekly downloads
-
License
-
Repository
-
Last release
2 years ago

nuxt2-storybook-ts

  1. Package manager:
    • Yarn
  2. Programming language:
    • TypeScript
  3. UI framework:
    • Tailwind CSS
  4. Nuxt.js modules:
    • Axios - Promise based HTTP client
  5. Linting tools:
    • ESLint
    • Prettier
    • StyleLint
  6. Testing framework:
    • Jest
  7. Rendering mode:
    • Universal (SSR / Static)
  8. Deployment target:
    • Server (Node.js hosting)
  9. Development tools:
    • jsconfig.json
  10. Continuous Integration:
    • none

Build Setup

# install dependencies
$ yarn install

# serve with hot reload at localhost:3000 -.env.local
$ yarn local

# serve with hot reload at localhost:3000 -.env.development
$ yarn dev

# build for production and launch server -.env.production
$ yarn build
$ yarn start

# generate static project
$ yarn generate

# serve storybook at localhost:6006
$ yarn storybook

# storybook build for production
$ yarn build-storybook

# serve json server at localhost:5001
$ yarn mock

# lint js
$ yarn lint:js

# lint style
$ yarn lint:style

# lint prettier
$ yarn lint:prettier

# lint all
$ yarn lint

# linst fix all
$ yarn lintfix

For detailed explanation on how things work, check out the documentation.

Special Directories

You can create the following extra directories, some of which have special behaviors. Only pages is required; you can delete them if you don't want to use their functionality.

assets

The assets directory contains your uncompiled assets such as Stylus or Sass files, images, or fonts.

More information about the usage of this directory in the documentation.

components

The components directory contains your Vue.js components. Components make up the different parts of your page and can be reused and imported into your pages, layouts and even other components.

More information about the usage of this directory in the documentation.

layouts

Layouts are a great help when you want to change the look and feel of your Nuxt app, whether you want to include a sidebar or have distinct layouts for mobile and desktop.

More information about the usage of this directory in the documentation.

pages

This directory contains your application views and routes. Nuxt will read all the *.vue files inside this directory and setup Vue Router automatically.

More information about the usage of this directory in the documentation.

plugins

The plugins directory contains JavaScript plugins that you want to run before instantiating the root Vue.js Application. This is the place to add Vue plugins and to inject functions or constants. Every time you need to use Vue.use(), you should create a file in plugins/ and add its path to plugins in nuxt.config.js.

More information about the usage of this directory in the documentation.

static

This directory contains your static files. Each file inside this directory is mapped to /.

Example: /static/robots.txt is mapped as /robots.txt.

More information about the usage of this directory in the documentation.

store

This directory contains your Vuex store files. Creating a file in this directory automatically activates Vuex.

More information about the usage of this directory in the documentation.

■ json server

  • 포트 변경 추가 옵션
    • --port 5001
  • Now you can access resources using additional routes.(라우팅 경로 추가 옵션)
    • --routes mock/routes.json
  • Watch file(s)
  • --watch mock/_db.json
yarn add -D json-server
Options:
  --config, -c       Path to config file           [default: "json-server.json"]
  --port, -p         Set port                                    [default: 3000]
  --host, -H         Set host                             [default: "localhost"]
  --watch, -w        Watch file(s)                                     [boolean]
  --routes, -r       Path to routes file
  --middlewares, -m  Paths to middleware files                           [array]
  --static, -s       Set static files directory
  --read-only, --ro  Allow only GET requests                           [boolean]
  --no-cors, --nc    Disable Cross-Origin Resource Sharing             [boolean]
  --no-gzip, --ng    Disable GZIP Content-Encoding                     [boolean]
  --snapshots, -S    Set snapshots directory                      [default: "."]
  --delay, -d        Add delay to responses (ms)
  --id, -i           Set database id property (e.g. _id)         [default: "id"]
  --foreignKeySuffix, --fks  Set foreign key suffix, (e.g. _id as in post_id)
                                                                 [default: "Id"]
  --quiet, -q        Suppress log messages from output                 [boolean]
  --help, -h         Show help                                         [boolean]
  --version, -v      Show version number                               [boolean]