Giter Club home page Giter Club logo

moon-ssr's Introduction

Moon SSR

Server Side Rendering for Moon

What?

Since some clients (such as those with IE9 and below) don't have support for Moon, so you can send prerendered html over, and Moon will automatically rerender on the client if possible.

Installation

npm install moon-ssr

Usage

const MoonSSR = require('moon-ssr');
MoonSSR.renderToString(instance);

Full Example

First, install some dependencies with:

npm install moonjs moon-ssr express

Next, let's create a simple Moon app.

Create an index.html file

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <title>Moon SSR</title>
  </head>
  <body>
    <!-- Where our app is mounted -->
    <div id="app"></div>

    <!-- Require Moon -->
    <script src="/js/moon.js"></script>
    <!-- Require our Moon App -->
    <script src="./js/scripts.js"></script>
    <!-- We mount it only on the client -->
    <script>app.mount("#app");</script>
  </body>
</html>

Next, add the Moon application code in js/scripts.js

(function(root) {
  'use strict'

  // Function that returns a Moon Instance
  var init = function() {
    return new Moon({
      template: '<div id="app">{{msg}}</div>',
      data: {
        msg: "Hello Moon!"
      }
    });
  }

  // If in node, export it,
  // if in the browser, create a global variable
  // with the instance
  if(typeof module !== 'undefined' && module.exports) {
    module.exports = init;
  } else {
    root.app = init();
  }
})(this);

Finally, lets create the server in server.js

// Require dependencies for Moon
global.Moon = require('moonjs');
const MoonSSR = require('moon-ssr');

// Some dependencies for I/O
const fs = require('fs');
const path = require('path');

// Our HTML layout file
const layout = fs.readFileSync('./index.html', 'utf8');

// Here we are using express, but you can use whatever
// you'd like
const express = require('express');
const server = express();

// Start a static server serving our javascript assets
server.use('/js', express.static(path.join(__dirname, 'js')));

// Get the '/' route and send over the server rendered content
server.get('/', (req, res) => {
  // Create a new instance of our Moon App
  const app = require('./js/scripts.js')();

  // Render our App to HTML
  const html = MoonSSR.renderToString(app);

  // Send it over to the client
  res.send(layout.replace('<div id="app"></div>', html));
});

// Start the Server on http://localhost:3000
server.listen(3000);

License

Licensed under the MIT License by Kabir Shah

moon-ssr's People

Contributors

kbrsh avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.