simple-sls-ssr
v1.3.1
Published
A lightweight, simple package for turning Serverless Framework into a server side rendering application.
Downloads
19
Readme
Simple SLS SSR
A simple helper package to turn Serverless Framework into a Server-Side Rendering Application. Uses a very basic Templating Engine for building application pages.
Quickstart use within a Lambda
Setup
- Create a folder in your root named
/templates. - Create your HTML files to use as templates in the
/templatesfolder. - Create a folder in your root named
/styles. - Create your CSS files in the
/stylesfolder. - Create a folder in your root named
/scripts. - Create your Javascript files in the
/scriptsfolder. - Name your CSS and Javascript files the same as your HTML files (file extension will be different of course)
Serving a page
const { render } = require('simple-sls-ssr')
// Your Lambda
module.exports.myfunction = async (event, context) => {
return await render('dashboard')
}This will render a page in the templates folder named dashboard.html.
Serving a page with variables
Use handlebars to declare your variable name.
hello.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Hello World</title>
</head>
<body>
<h1>Hello {{name}}</h1>
</body>
</html>module.exports.myfunction = async (event, context) => {
const variables = {
name: "Jane"
}
return await render('hello', variables)
}Setting Custom Headers
module.exports.myfunction = async (event, context) => {
const headers = {
'Content-Type': 'application/json'
}
return await render('hello', null, headers)
}Setting Custom Style Sheet
The render function will look for the CSS file in the styles folder that is named the same as the view.
module.exports.myfunction = async (event, context) => {
const headers = {
'Content-Type': 'application/json'
}
return await render('hello', null, headers, true)
}Setting Custom Javascript File
The render function will look for the Javascript file in the scripts folder that is named the same as the view.
module.exports.myfunction = async (event, context) => {
const headers = {
'Content-Type': 'application/json'
}
return await render('hello', null, headers, false, true)
}Redirecting to another page
const { response } = require('simple-sls-ssr')
module.exports.myfunction = async (event, context) => {
const relativePath = './login'
return response.redirect(relativePath)
}Returning non-templated, HTTP responses
const { response } = require('simple-sls-ssr')
module.exports.myfunction = async (event, context) => {
const body = { success: "hello world!" }
const customHeaders = { "myCookie" : "Cookie123"}
return response.http(200, body, customHeaders)
}