neodymium template

A full-featured neodymium stack setup.

Documentation

Common topics are discussed in the docs. Make sure to read it!

Usage

This is a project template for vue-cli. It is recommended to use npm 3+ for a more efficient dependency tree.

$ npm install -g vue-cli
$ vue init soixantecircuits/nd my-project
$ cd my-project
$ npm install
$ npm run dev

What's Included

• npm start: first-in-class development experience.

  • Webpack + vue-loader for single file Vue components.
  • State preserving hot-reload
  • State preserving compilation error overlay
  • Lint-on-save with ESLint
  • Source maps
  • Autorun npm run electron in Electron enabled apps.

• npm run build: Production ready build.

  • JavaScript minified with UglifyJS.
  • HTML minified with html-minifier.
  • CSS across all components extracted into a single file and minified with cssnano.
  • All static assets compiled with version hashes for efficient long-term caching, and a production index.html is auto-generated with proper URLs to these generated assets.

• npm run electron: developpers friendly features when working in a dev environment.

  • Auto opens the devtools.

• npm run package: Package your app for distribution with electron-packager.

  • Portable version of your app (NodeJS and WebKit embedded).
  • Package for Windows/OS X/Linux.
  • Remove all devDependencies from the packaged binary, reducing final size a lot.

Fork It And Make Your Own

You can fork this repo to create your own boilerplate, and use it with vue-cli:

vue init username/repo my-project

Credits

This is originally a fork of the webpack template. Most credit goes to them! 👏

The neodymium stack was originally designed as a yeoman generator. You can take a look here.