JavaScript HTML
Latest commit aba97fc Jul 1, 2017 @egoist egoist update dependencoes
Permalink
Failed to load latest commit information.
app allow to set options for root instance Jun 28, 2017
bin Revert "use prettier" May 24, 2017
examples update dependencoes Jul 1, 2017
lib update dependencoes Jul 1, 2017
plugins tweaks Jul 1, 2017
test Revert "use prettier" May 24, 2017
.editorconfig init Mar 19, 2017
.gitattributes init Mar 19, 2017
.gitignore generate files in `.ream/dist` folder Mar 25, 2017
CHANGELOG.md -> v1.0.0-rc.5 Jun 1, 2017
LICENSE init Mar 19, 2017
README.md fix typo May 17, 2017
circle.yml init Mar 19, 2017
package.json update dependencoes Jul 1, 2017
ream.config.js Revert "use prettier" May 24, 2017
server.js Revert "use prettier" May 24, 2017
yarn.lock update dependencoes Jul 1, 2017

README.md

ream


NPM version NPM downloads
Build Status
codecov donate

Introduction

Server-side rendered Vue.js app should be made easy, since vue-router is well optimized for SSR, we built ream on the top of it to make you build universal Vue.js app fast with fewer trade-offs, the only requirement is to export router instance in your entry file, which means you have full control of vue-router as well!

How does this compare to Next.js/Nuxt.js?

Features

Check out online docs or Try writing server-rendered Vue.js app online!

Install

yarn add ream

Usage

You may use create-ream-app to kick start a new project, or add npm scripts manually:

{
  "scripts": {
    "build": "ream build",
    "start": "ream start",
    "dev": "ream dev"
  }
}

Then populate an src/index.js in current working directory and it should export at least router instance:

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

Vue.use(Router)

const createRouter = () => new Router({
  mode: 'history',
  routes: [/* ... */]
})

export default { createRouter }

Run npm run dev to start development server.

To run in production server, run npm run build && npm start

Dive into the documentation to get more.

Prior Art

ream wouldn't exist if it wasn't for excellent prior art, we're inspired by these projects:

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

egoistian.com Β· GitHub @egoist Β· Twitter @rem_rin_rin