Skip to content

Latest commit

 

History

History
84 lines (55 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

84 lines (55 loc) · 1.42 KB

CONTRIBUTING

Replace npm xxx commands with yarn commands if you are using it instead.

Project setup

Install dependencies

npm install

VS Code Extensions

Development

Development server with demo powered by vue cli

npm run serve

Open http://localhost:8080 for demo

(Optional) Upload Server

Fire up the built in example node upload server

npm run upload-server

Open http://localhost:3000 for upload server

Testing and Linting

npm run test:unit
npm run lint

To develop tests and watch

npm run test:watch

Production Build

Compiles and minifies for production

npm run build

Documentation

Jekyll is required for building documentation

Build and watch the library under dist_dev for documentation consumption

npm run build:dev

Serve the documentation consuming built files from dist_dev

npm run docs:serve:dev
or
jekyll serve --config _config.yml,_config_dev.yml --host 0.0.0.0

Serve the documentation consuming built files from dist

npm run docs:serve
or
jekyll serve --host 0.0.0.0