🧩 Puzzle

Puzzle is boilerplate for Vue.js packages that is used in our company.

What's in the Box?

• Rollup.js as module bundler
• Vue-cli for dev server
• VuePress for docs
• A package.json file with build/dev scripts and dependencies
• Minimal .babelrc and .browserslistrc file for transpiling

Setup

Download master branch

git clone https://github.com/64robots/puzzle.git

Install the dependencies

yarn

For development you can start a local server

yarn serve

Once your development is done it's time to compile your package

yarn build

Tailor for your needs

It will work as it is we'll need to modify a few files to get the package tailored for our development, let's dive in.

Package.json

Replace the PACKAGE_NAME string with your package name

Components

Components live in the src/components directory. Any new component should be registered in the src/index.js file so they will be exposed as part of the package.

Documentation

Documentation live in the docs folder. You can create any pages and/or modify the current ones as your need. Also note to modify the docs/.vuepress/config.js file to add the package repo, package name and so on. Reference vuepress docs for a more detailed version

---

Based on vue-sfc-rollup