Backend service for server-side rendering react applications with django.
Project description
React SSR (Backend)
Description
Back-end service for server-side rendering react applications with django. This compliments the react-ssr-frontend node package.
Installation
pip install react-ssr
or
pipenv install react-ssr
Methods
-
react_render(request, initial_state, extra_context, template_name, render_url, render_timeout, secret_key, extra_headers) - Renders the react appplication and returns the resulting markup with additional data as JSON data.
-
get_initial_state(request, data) - Returns a dictionary that includes an "auth" object that contains the current user, the API Key, and any extra data provided from the view.
Views
- ReactSSRView - A class based view that implements a process for rendering react on the server with django.
Usage
Template:
{% load render_bundle from webpack_loader %}
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- For page title -->
<title>{% spaceless %}
{% if page_title %}
{% project_name %} - {{ page_title }}
{% else %}
{% project_name %}
{% endif %}
{% endspaceless %}</title>
<!-- For page description -->
<meta name="description" content="{% spaceless %}
{% if page_description %}
{{ page_description }}
{% endif %}
{% endspaceless %}">
<!-- Initial state -->
<script>window.__STATE__ = {{ state | safe }}</script>
<!-- For lazy-loaded components -->
{{ script | safe }}
</head>
<body>
{% spaceless %}
<main role="main">{{ html | safe }}</main>
{% render_bundle "runtime" %}
{% render_bundle "vendor" %}
{% render_bundle "app" %}
{% endspaceless %}
</body>
</html>
With function based views:
# settings.py
REACT_RENDER = {
"URL": "http://127.0.0.1:3000/render",
"TIMEOUT": 30,
"TEMPLATE": "index_ssr.html",
"SECRET_KEY": "THIS_IS_A_SECRET_KEY",
"USER_SERIALIZER": "path.to.user.serializer",
}
# views.py
from react_render.render import react_render
from react_render.utils import get_initial_state
def index(request):
initial_state = get_initial_state(request, {
"home": {
"stateKey": "stateValue",
}
})
extra_context = {
"page_title": "Home"
"page_description": "This is the home page"
}
return react_render(request, initial_state, extra_context)
or with class based view:
# views.py
from react_render.views import ReactSSRView
class IndexView(ReactSSRView):
extra_context = {
"page_title": "Index",
"page_description": "This is a description"
}
def build_page_state(self, request, *args, **kwargs):
state = self.get_default_state("index")
return {
"index": state,
}
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for react_ssr-0.1.7-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d9d8e5c3550d8d1f349b9e750551224b5844ab83146f26866e4402b807a17f2d |
|
| MD5 | e098471b83b73a012e9b89458b8e0fc5 |
|
| BLAKE2b-256 | 4d13f049b031be63e76f83d0d58082184168ec2cf2f52f5c24758e9f4c1fcc83 |
