基于react的一个同构 nodeJS 框架

基于react的一个同构 nodejs 框架

PlasmaJS

An isomorphic NodeJS framework powered with React for building web apps.

Use the starter-kit to get up and running with PlasmaJS [OUTDATED]

Join us on discord

Features

Declarative syntaxIsomorphic routingIsolated routing for API endpointsMaintainable middlewaresES6 syntax with babel

Installation

Install with npm npm i --save plasmajs(you can also install it globally with npm i -g plasmajs)To run the server, plasmajs path/to/server.js(Add it to your package.json scripts for local install)

Guide

Import it to your app.js

import { Server, Route, Router, NodeHistoryAPI } from 'plasmajs';

Writing A Server

const HeadLayout = props => ( );const WrapperLayout = props => {props.children};const HomeLayout = props =>

;const ErrorLayout = props => ;export default class App extends React.Component { // Port number (Default=8080) static port = 8080; render() { const history = new NodeHistoryAPI(this.props.request, this.props.response); return ( ); }}

Middlewares

Writing custom middlewares

In MyMiddleWare.jsx...

import { MiddleWare } from 'plasmajs';export default class MyMiddleWare extends MiddleWare { onRequest(req, res) { // Do your magic here // Run this.terminate() to stop the render and take over }}

And in App's render method...

// ...

Logger middleware

It logs information about the request made to the server out to the console.

import {Logger} from 'plasmajs' // and add it in the server but after the router declaration.

// ...

Props color (boolean) - Adds color to the logs if true

StaticContentRouter middleware

Allows you to host a static content directory for public files

import {StaticContentRouter} from 'plasmajs'

// ...

Props dir (string) - The name of the static content folder to hosthasPrefix (boolean) - If set to false, will route it as http://example.com/file instead of http://example.com/public/filecompress (boolean) - If true, will enable gzip compression on all static content if the client supports it

APIRoute middleware

Allows you to declare isolated routes for requests to api hooks

import {APIRoute} from 'plasmajs' //... // API request handler for api routes _apiRequestHandler() { // Return a promise return new Promise((resolve, reject) => { resolve({ wow: "cool cool" }); }); } render() { return ( //... ); }

Props method (string) - The http request methodpath (string or regex) - The path to matchcontroller (function) - The request handler

Routing

Isomorphic routing which renders the content on the server-side and then lets the javascript kick in and take over the interactions. (The server side rendering only works for Push State routing on the client side, not Hash routing).

NOTE: Its better to isolate the route definitions to its own file so that the client-side and the server-side can share the components

History API

There are 3 types of routing available - Backend routing(new NodeHistoryAPI(request, response)), Push State routing(new HistoryAPI(options)), Hash routing(new HashHistoryAPI(options))(NOTE: The naming is just for consistency)

The Router

{allRouteDeclarations}

Props history (object) - It's the history api instance you pass in depending on the kind of routing you require.wrapper (React component class) - It is a wrapper for the routed contents

Declaring a route

If Homepage is a react component class and / is the url.

Props path (string or regex) - The url to route the request tocomponent (React component class) - The component to be rendered when the route is triggeredstatusCode (integer) - The status code for the responsecaseInsensitive (boolean) - Set to true if you want the url to be case insensitiveerrorHandler (boolean) - Set to true to define a 404 error handler

Want to help?

PRs are welcome. You can also join us on discord for discussions about plasmajs.

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。