Badges
tl;dr
vbuild whatever.js --dev# it just works Develop web apps with no build configuration until you need.
Install
It works with both Yarn(>=0.17) and npm(>=3):
yarn global add vbuild# You can also install it locally # yarn add vbuild --dev How to use
The simple way (using create-vue-app)
yarn global add create-vue-appcreate-vue-app my-app# or `cva my-app` Then follow the instructions in terminal.
Or manually, populate an entry file, let's say index.js:
el: '#app' { return }Run app in dev mode:
vbuild index.js --devSo far we get:
- Automatic transpilation and bundling (with webpack and babel/postcss)
- Hot code reloading
- Static file in
./static/will be copied to./dist/
Build app in production mode (default mode):
vbuild index.jsNote: You can use vbuild with many frameworks easily, check out examples.
For full documentation, please head to https://vbuild.js.org
FAQ
Is it like Next.js or Nuxt.js?
Yes and no, yes is because they all simplified the process of building a complete web app, while vbuild is more focusing on building single-page app without the server-side, at least it is for now.
Is it like vue-cli?
No, vue-cli is just a boilerplate generator while vbuild is a Webpack wrapper which reduces boilerplate code for you.
You may notice that there's a vue build command lying in vue-cli, that's actually quite similar to vbuild, but providing less features and vbuild goes far beyond that.
Is there a `--watch` mode?
Sure, you can combine the --watch mode with default mode and --dev mode, when it's combined with --dev mode, it will remove the hot-reloading support.
What are the differences between `--watch` `--dev` and production mode?
The default mode is production mode, i.e. without --dev.
--dev mode uses hot reloading by default, when your file does not support hot reloading it fallbacks to live reloading.
--watch can be used with/without -dev flag:
- with
--dev: no dev server, no hot reloading, since you may not need to open browser at all. It only rebuilt when file changes, all other features indevare the same. - without
--dev: like production mode but it rebuilt due to file changes.
What is this inspired by?
Despiting that vbuild predates Next.js create-react-app nwb vue-cli, we're heavily inspired by these projects.
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :D
Author
vbuild © EGOIST, Released under the MIT License.
Authored and maintained by egoist with help from contributors (list).
egoistian.com · GitHub @egoist · Twitter @rem_rin_rin