https://github.com/meteorhacks/meteor-ssr
Server Side Rendering for Meteor
https://github.com/meteorhacks/meteor-ssr
Last synced: 5 months ago
JSON representation
Server Side Rendering for Meteor
- Host: GitHub
- URL: https://github.com/meteorhacks/meteor-ssr
- Owner: meteorhacks
- Created: 2014-09-28T14:20:48.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-05-04T13:53:31.000Z (almost 8 years ago)
- Last Synced: 2024-02-12T05:38:52.512Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://atmospherejs.com/meteorhacks/ssr
- Size: 223 KB
- Stars: 262
- Watchers: 15
- Forks: 28
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-blaze - meteorhacks:ssr - Server Side Rendering for Meteor.  (Uncategorized / Uncategorized)
README
[](https://travis-ci.org/meteorhacks/meteor-ssr)
# Server Side Rendering for Meteor
Now, you can render Blaze templates on the server very easily. And also, you can assign helpers for templates in the server as well.
> Previously, this package loads all the client side templates when your app starts.
> But now meteor don't allow us to do that. So that behaviour has been removed.
### Installation
```bash
meteor add meteorhacks:ssr
```
## Usage
> This package only works on the server
First create templates and helpers
~~~js
SSR.compileTemplate('emailText', 'Hello {{username}},
Now time is: {{time}}');
Template.emailText.helpers({
time: function() {
return new Date().toString();
}
});
~~~
Then you can render above template anywhere in your app.(only on server)
~~~js
Meteor.methods({
sendEmail: function() {
var html = SSR.render("emailText", {username: "arunoda"});
console.log(html);
}
});
~~~
### Better way to load templates
It's not a good idea to write template(html) inside javascript. So, we can use following approach.
Write your html content inside the `private` directory.
~~~html
Hello {{username}},
Now time is: {{time}}
~~~
Then load it like this:
~~~js
SSR.compileTemplate('emailText', Assets.getText('hello.html'));
Template.emailText.helpers({
time: function() {
return new Date().toString();
}
});
~~~
You can render the template as previously.
## API
#### SSR.render(template, data)
You can render a template with data. For `template` argument you can either pass the name of the template or the actual template instance itself.
#### SSR.compileTemplate(templateName, stringTemplateContent, [options])
You can use this API to compile templates in the server. The `options` parameter allows you to choose the template language with the `language` option.
If not provided this default to `html` which is handled by the spacebars compiler.
You can also use `jade` as another option — and in this case you need to add following package:
~~~
meteor add mquandalle:jade
~~~
Note: the order in which you add jade and SSR matters! First add jade as a dependency and then SSR, otherwise the jade-compiler can not be located by Meteor.
## What can we do with SSR
Since, this is full Blaze on the server, you can have sub-templates, dynamic templates and all the awesome features of Blaze. These are the few things you can do with SSR.
* Render HTML pages for SEO bots
* Render HTML pages for some of your routes (you may need to serve html yourself)
* Build SEO aware static sites
* Handy email templates with Blaze
## Wow, How you did this
Actually, most of the stuff has been already done by Meteor, so kudos to Meteor team.
* This also, adds some patches to Blaze.
* Finally, this package comes with a clean and nice API to render templates.