webfrontzhifei/ream

🚀 Framework for building universal web app

Ream

Features

• Boilerplate-free, dramatically reduce boilerplate code
• Pluggable renderer, no more Vue vs React debate
• Extensible webpack config
• Generate static website
• Programmatic usage

Install

yarn add ream@next

# If you're using Vue
# Install this too:
yarn add ream-renderer-vue@next

Usage

First, populate an entry file src/index.js:

import Vue from 'vue'
import Router from 'vue-router'

Vue.use(Router)

const createRouter = () => new Router({
  mode: 'history',
  routes: [{
    path: '/',
    // And your component for homepage
    component: () => import('./Home.vue')
  }]
})

export default { createRouter }

Then configure the vue renderer in config file ream.config.js:

const Renderer = require('ream-renderer-vue')

module.exports = {
  entry: './src/index.js', // default value
  renderer: new Renderer()
}

Finally run ream dev to start dev server.

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).

egoist.moe · GitHub @egoist · Twitter @_egoistlily