πŸš€ Framework for building universal web app and static website.
JavaScript HTML
Latest commit d96bae0 Oct 5, 2017 @egoist egoist fix typo
Permalink
Failed to load latest commit information.
docs fix typo Oct 5, 2017
packages Publish Oct 5, 2017
.editorconfig init Aug 1, 2017
.gitattributes init Aug 1, 2017
.gitignore make cli work Aug 6, 2017
LICENSE add docs Aug 23, 2017
README.md compile renderer app Aug 23, 2017
lerna.json update lerna Aug 23, 2017
package.json add test script Aug 23, 2017
yarn.lock clean up Aug 23, 2017

README.md

Ream

NPM version NPM downloads
Build Status
codecov donate chat

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