IrvingZhao / ream

🚀 Build server-rendered apps using Vue.js

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

• Server-side rendering with code-split support
• Extensible webpack config
• Plugin system
• Next.js/Nuxt.js-like behavior via plugin
• Generate static website
• Writing blogs using Markdown/Vue Component
• Exposed a fluent API

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

Install

yarn add ream

Usage

Add npm scripts:

{
  "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:

• Nuxt.js
• Next.js

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