Starter

A Nuxt.js + Vuetify.js starter project template without the distraction of a complicated development environment.

Installation

This is a project template for vue-cli.

$ vue init ncviewer/vuetify-template my-project
$ cd my-project
                   
# run dev server
$ npm run dev
# OR
$ npx nuxt

Make sure to use a version of vue-cli >= 2.1 (vue -V).

Usage

Development

# serve with hot reloading at localhost
$ npm run dev

Go to http://localhost

Production

# build for production and launch the server
$ npm run build
$ npm start

Generate

# generate a static project
$ npm run generate

Continous Integration

Buddy works is used to automate our code tests. Currently this runs eslint and check if the site successfully builds.

PR's adding additional tests through the use of a tool like jest are welcomed.

Local Testing

To test locally, clone this repo and install dependancies through npm.

• After dependancies are installed, simply run: npm test

• A new folder test-build will be created with an instance of your template and settings as defined by /scenarios/full.json

• Then simply cd test-build and install the template dependancies with npm ci.

• Lastly run npm run build to generate the site (automatically runs linter).

• You can then Use npm start to start the server and verify any changes are functional as expected.

CI Server

In order to setup a CI server to run tests, create a configuration that clones the repo and automates the above tests.