🚀 Framework for building universal web app and static website in Vue.js (beta)
Clone or download
Permalink
Failed to load latest commit information.
app reconsider the api Aug 15, 2018
bin reconsider the api Aug 15, 2018
examples allow fsRoutes to be boolean Aug 16, 2018
lib getInitialData can be ObjectProperty Aug 17, 2018
.editorconfig init Feb 18, 2018
.gitattributes init Feb 18, 2018
.gitignore Use webpack 4 (#75) May 17, 2018
.prettierrc Use webpack 4 (#75) May 17, 2018
LICENSE init Feb 18, 2018
README.md update roadmap May 27, 2018
circle.yml init Feb 18, 2018
package.json properly ignore tests in npm package Aug 16, 2018
webpack.config.js export webpack config Jun 5, 2018
yarn.lock update deps Aug 16, 2018

README.md

NPM version NPM downloads CircleCI
donate chat

Install

yarn add ream

Usage

Unlike a regular Vue SPA, you must export a function which returns an object in your app entry in order to make it work with Ream:

// index.js
import Vue from 'vue'
import Router from 'vue-router'

Vue.use(Router)

export default () => ({
  router: new Router({
    mode: 'history',
    routes: [{
      path: '/',
      // Dynamically load your index component
      component: () => import('./index.vue')
    }]
  })
})

And that's it, run ream dev and have fun playing with your app at http://localhost:4000.

Roadmap

  • Document how to modify internal webpack config.
  • Add proper tests.

To make things happen faster, you may consider becoming a patron to support the development:

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

ream © egoist, Released under the MIT License.
Authored and maintained by egoist with help from contributors (list).

github.com/egoist · GitHub @egoist · Twitter @_egoistlily