Seashell

A message framework, a high-level communication protocol for node.js and javascript.

The master branch is in a fast iteration state, please use branch v0.6.x for stable usage.

Document

Examples

We have some examples in examples directory.

$ npm install seashell --save

// server
import Seashell from 'seashell'

const seashell = new Seashell();

seashell.use('/api', ctx => {
  ctx.response.body = {...};
  ctx.response.end()
})

seashell.listen(3333);

// client
import {App, Router} from 'seashell/lib/client'

app.connect('ws://127.0.0.1:3333?appId=APPID&appName=APPNAME&appSecret=APPSECRET');

app.request('/seashell/api');

Command Line Tool

$ npm install seashell-cli -g
$ seashell proxy src/index.js # Start a http server to proxy seashell app.

Road Map

• Streaming support.

Community

QQ Group: 310433696

LICENSE

MIT License.