d4rky-pl / arboris

Hassle-free combination of mobx-state-tree and server-side rendering.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Arboris

Hassle-free combination of mobx-state-tree and server-side rendering.

What it is

This library aims to simplify adding server-side rendering to your React application by using the power of mobx-state-tree.

It works by wrapping all asynchronous actions in tracking function and running your React components through initial rendering phase (prerendering). After the prerendering, Arboris will wait for all Promises to resolve and render your application once again, this time filled with all necessary data in store. Magic!

Arboris does not aim to solve the server-side rendering configuration prerequisites, you still need to figure out how to compile your server and client assets with webpack. We recommend Razzle for this.

Installation

run yarn add arboris or npm install arboris, depending on package manager you use. Easy peasy.

Usage

See getting started for step-by-step guide into implementing Arboris in your app.

Powered by Arboris

Arboris is maintained by developers at Untitled Kingdom. Here are some projects, where you can see MST in action:

Roadmap

See issues. Let us know about any issues you encounter and ideas you would like to see in next releases.

Testing

Just run yarn test or npm test.

Arboris is being testing against various MST versions. jest.setup.js script is taking care of installing it locally when running tests. If you want to add MST-dependent tests, add them to __tests__/mobx-state-tree/[mstVersion] directory and update jest.setup.js file.

About

Hassle-free combination of mobx-state-tree and server-side rendering.


Languages

Language:JavaScript 100.0%