Badges

tl;dr

vbuild dev whatever.js
# 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

Come from vbuild 6? Check out the 2-minute migration guide.

How to use

Populate an entry file, let's say index.js:

import Vue from 'vue'

new Vue({
  el: '#app',
  render(h) {
    return h('h1', 'hello world')
  }
})

Run app in dev mode:

vbuild dev index.js

So 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.js

Note: You can use vbuild with many frameworks easily, check out examples.

For full documentation, please head to https://vbuild.js.org

Who is using vbuild?

• codepan - Like codepen and jsbin but works offline.
• jsx-editor - JSX Live Editor
• vstar - A simple web app to show your or others GitHub repos stars
• npmarket - More efficient search for node packages
• sublog - Build a static blog website from GitHub Issues
• Feel free to submit yours via pull request :D

FAQ

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.

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.

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. 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