https://github.com/64robots/puzzle
Our boilerplate for Vue.js packages
https://github.com/64robots/puzzle
Last synced: about 1 year ago
JSON representation
Our boilerplate for Vue.js packages
- Host: GitHub
- URL: https://github.com/64robots/puzzle
- Owner: 64robots
- License: mit
- Created: 2020-04-29T14:00:24.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-12T15:22:42.000Z (over 3 years ago)
- Last Synced: 2025-04-11T18:56:44.866Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 1.32 MB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🧩 Puzzle
Puzzle is boilerplate for Vue.js packages that is used in our company.
## What's in the Box?
- [Rollup.js](https://rollupjs.org/) as module bundler
- [Vue-cli](https://cli.vuejs.org/) for dev server
- [VuePress](https://vuepress.vuejs.org/) for docs
- A `package.json` file with build/dev scripts and dependencies
- Minimal .babelrc and .browserslistrc file for transpiling
## Setup
Download master branch
```bash
git clone https://github.com/64robots/puzzle.git
```
Install the dependencies
```bash
yarn
```
For development you can start a local server
```bash
yarn serve
```
Once your development is done it's time to compile your package
```bash
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](https://vuepress.vuejs.org/guide/basic-config.html#config-file) for a more detailed version
---
Based on [vue-sfc-rollup](https://github.com/team-innovation/vue-sfc-rollup)