A React bridge for Django
Project description
Django React Bridge
Think at Create React App but for Django
Installation
pip install django-react-bridge
Configuration
Add react_bridge to the installed apps:
INSTALLED_APPS = (
# ...
'react_bridge',
)
Add the react components context processor:
TEMPLATES = [
{
# ...
'OPTIONS': {
'context_processors': [
# ...
'react_bridge.context_processors.react_components',
],
},
},
]
Configure react bridge:
REACT_BRIDGE_JS_CONFIG = {
'use_yarn': True,
'npm_command': 'yarn',
'output_path': os.path.join(BASE_DIR, 'static/build'),
'output_url': '/static/build/',
# Webpack resolve: https://webpack.js.org/configuration/resolve/#resolve
'resolve': None,
# Webpack entry: https://webpack.js.org/configuration/entry-context/#entry
'entry': None,
# Es:.
'entry': os.path.join(BASE_DIR, 'js/src/index.js'),
}
# Use js bridge in dev mode
REACT_BRIDGE_DEV = True
To use django-react-bridge with the default configuration you should
include your top static in your STATICFILES_DIRS or your can change
output_path according to your staticfile configuration.
STATICFILES_DIRS = [
os.path.join(BASE_DIR, 'static'),
]
Usage
Inside your entry javascript file:
import React from 'react'
import ReactDOM from 'react-dom'
import { registerComponents } from 'django-react-bridge'
import MyComponent from './MyComponent'
registerComponents({
React,
ReactDOM,
components: {
// Register here yuor components
MyComponent,
}
})
Inside your Django template:
{% load react_bridge %}
<html>
<head>
{% react_head_tags %}
</head>
<body>
{% render_component "MyComponent" in_tag='div' myPropA='a' myPropB='b' %}
{% react_body_tags %}
</body>
</html>
Multi bundle set up:
If you need to split your app in multiple bundles:
REACT_BRIDGE_JS_CONFIG = {
'entry': {
'frontend': os.path.join(BASE_DIR, 'front/src/index.js'),
'admin': os.path.join(BASE_DIR, 'admin/src/index.js'),
}
}
Then in your template you need to pass the bundle name when render related tags:
{% load react_bridge %}
<html>
<head>
{% react_head_tags 'admin' %}
</head>
<body>
{% react_body_tags 'admin %}
</body>
</html>
Commands
jsdevserver
Start dev server on port 9000.
You should have REACT_BRIDGE_DEV = True.
python manage.py jsdevserver
jsbuild
Build your js and realted assets according to your REACT_BRIDGE_JS_CONFIG.
python manage.py jsbuild
jsinit
Init a js project at given path.
python manage.py jsinit path/to/my/js/project
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 django-react-bridge-0.0.2.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e43da71ad3685569b5122d45d72bf6ce880835b778be0b8f25fc607a51da66b5 |
|
| MD5 | 469d74c5a709078e0f8d1e8e67dc7584 |
|
| BLAKE2b-256 | c1e62d351ed2f57c9cd817f949e8ad15aeab2e35cc0daa2c51dfd6555cf64f9f |
Hashes for django_react_bridge-0.0.2-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | abfa15a67a837098a9c9f78a31945bfb8a1bee7885b918e45f15d07742f71d45 |
|
| MD5 | 43f81efa4a095cfb493b8a268d23cdc1 |
|
| BLAKE2b-256 | a3ca24d328b2f8a70ff3a47ae347814f95a22dd30d1fa81fb7159be384c22ff5 |
