Render React.js components on any backend
JavaScript
Latest commit bd1fe47 May 23, 2016 @mjackson Version 3.1.0
Permalink
Failed to load latest commit information.
bin Whitespace Mar 11, 2016
scripts Add release script Mar 8, 2016
.gitignore add .gitignore Jan 4, 2016
README.md Update install instructions Mar 11, 2016
package.json Version 3.1.0 May 23, 2016
server.js Style tweaks Apr 6, 2016

README.md

react-stdio npm package

react-stdio lets you render React components on the server, regardless of the backend technology you're using.

As its name suggests, other processes communicate with react-stdio using standard streams. The protocol is JSON, so any environment that can spawn a child process and write JSON to its stdin can use the server. Requests are handled serially, so responses are issued in the same order requests are received.

Installation

Using npm:

$ npm install -g react-stdio

Usage

Once you've installed the server, you will have a react-stdio binary available (assuming node_modules/.bin is in your $PATH). Execute it to start the server.

To render a React component, write a JSON blob to stdin with any of the following properties:

component       The path to a file that exports a React component (required)
props           Any props you want to pass to the component (optional, default is {})
render          The type of rendering (optional, default is renderToString)

If the request is successful, the server will put a JSON blob with {"html":"..."} on stdout. If the request fails for some reason, the JSON will have an error property instead of html.

Example:

$ echo '{"component":"./MyComponent","props":{"message":"hello"}}' | react-stdio

If you'd like to use a render method other than renderToString or renderToStaticMarkup you can pass a path to a file that exports your rendering function. The signature of your render function should be:

function render(element, callback) {
  // ...
}

This function is asynchronous so you have time to do data fetching before you render if you wish. Call callback(error, html) when you're finished.

Environment

Your component file is loaded in a vanilla node.js environment. If you need additional code transforms to run (e.g. using webpack or Browserify) you should create your bundle first and tell react-stdio to load your bundle instead of the plain component file. If you're using webpack to build your bundle, you'll want to use "libraryTarget": "commonjs2" in your config so the bundle exports the component using module.exports = MyComponent.

Also, since react-stdio uses the stdout stream for all program output, all writes your code makes to process.stdout (including console.log statements) are redirected to process.stderr.

Integrations

If you'd like to add an integration here, please submit a PR.