A Truly Full-Stack Development Experience with Python and React
Project description
GingerJs
✨ 🚀 Full-Stack Development Experience with Python and React ✨ 🚀
Unlike typical setups where Node.js serves as the backend for frontend applications, this project leverages Python to deliver a comprehensive full-stack solution.
Install GingerJS
Python Environment and Requirements
Create a virtual environment to manage dependencies locally:
virtualenv env
Activate the virtual environment:
source env/bin/activate
Alternatively:
. env/bin/activate
Now, you need to install GingerJS using pip
. Open your terminal or command prompt and run the following command:
pip install git+https://github.com/ginger-society/ginger-js.git
Alternatively:
pip install ginger-js
Create your app
gingerjs create-app
Run server
gingerjs runserver
The application will run on port 5001 by default. If 5001 is already in use, You can change the default port by adding port in main.py
app.run_app(debug=True, host="0.0.0.0", port=<PORT>)
Main Features
Some of the main py-react features include:
Feature | Description |
---|---|
Routing | A file-system based router built on top of Flask and Server Components that supports layouts, nested routing, loading states, and more. |
Rendering | Client-side and Server-side Rendering with Client and Server Components. Further optimized with Static and Dynamic Rendering on the server with py-react. |
Styling | Support for your preferred styling methods, including CSS Modules, Tailwind CSS, and CSS-in-JS |
Pre-Requisite Knowledge
Although our docs are designed to be beginner-friendly, we need to establish a baseline so that the docs can stay focused on py-react functionality. We'll make sure to provide links to relevant documentation whenever we introduce a new concept.
To get the most out of our docs, it's recommended that you have a basic understanding of Flask,HTML, CSS, and React. If you need to brush up on your React skills, check out this React Foundations Course and FLask, which will introduce you to the fundamentals.
Creating your First Page
Layouts
A layout is UI that is shared between multiple routes. On navigation, layouts preserve state, remain interactive. Layouts can also be nested.
You can define a layout by default exporting a React component from a layout.jsx file. The component will be populated with a child layout (if it exists) or a page during rendering.
import React from "react";
import Header from "../components/header";
import { Outlet } from "react-router-dom";
const Layout = (props) => {
return (
<div className="p-4">
<Header />
<Outlet />
</div>
);
};
export default Layout;
For example, the layout will be shared with the /dashboard and /dashboard/settings pages:
If you were to combine the two layouts above, the root layout (app/layout.jsx) would wrap the dashboard layout (app/dashboard/layout.jsx), which would wrap route segments inside app/dashboard/*.
The two layouts would be nested as such:
Linking and Navigating
There are currently two ways to navigate between routes in gingerJs:
- Using the Link Component (currently exported from libs)
- Using the useNavigate hook (currently exported from libs)
This page will go through how to use each of these options, and dive deeper into how navigation works.
Dynamic Routes
When you don't know the exact segment names ahead of time and want to create routes from dynamic data, you can use Dynamic Segments that are filled in at request time.
Convention
A Dynamic Segment can be created by wrapping a folder's name in square brackets: [folderName]. For example, [id] or [slug].
You can use useParam hook to get the values in component/pages
For ecample if your folder structure looks like src/app/products/[productId]/index.jsx
import React, { useEffect, useState } from "react";
import { useParams } from "react-router-dom";
function Product() {
const { productId } = useParams();
return (
<>
{productId}
</>
);
}
export default Product;
Alternatively:
import React, { useEffect, useState } from "react";
import { useParams } from "react-router-dom";
function Product({productId}) {
return (
<>
{productId}
</>
);
}
export default Product;
Server-Side Props
In a Python environment, you can fetch data, interact with the database, and pass the data to your page.
Convention
The server logic is placed alongside index.jsx
and layout.jsx
within the same folder and is named index.py
.
Example
Server Example
Path Example : src/app/index.py
import requests
def index(request):
api_url = f'https://dummyjson.com/products/' # Replace this with the URL of the API you want to fetch data from
# ----or---
# productId = request.args.get("productId")
# api_url = f'https://dummyjson.com/products/
response = requests.get(api_url)
if response.status_code == 200:
data = response.json()
return {"products":{data}}
return {"products":{"data": None,"error":{"message":"Something went wrong! Please try again"}}}
Component Example
Path Example : src/app/products/[productId]/index.jsx
import React, { useEffect, useState } from "react";
import { useParams } from "react-router-dom";
function Products({products}) {
return (
<>
{JSON.stringify(products,null,4)}
</>
);
}
export default Products;
layout server Example
If you want to pass props to layout you just have to define a layout in your index.py
Path Example : src/app/index.py
def layout(request):
return {"serverData":"some_data"}
layout client Example
Path Example : src/app/layout.jsx (will be visible to all subroute)
function Layout({serverData}) {
return (
<>
<div className="p-0 m-0">
<Header data={serverData}/>
<Outlet />
</div>
</>
);
}
export default Layout;
Middleware Example
Or you want attach a middleware, Just define a middleware in index.py
Path Example : src/app/index.py
def middleware(request,abort):
token = request.headers.get('X-Auth-Token')
if token != 'secret-token':
return abort(401,{"error":"No Auth"})
return
Api Example
Path Example : src/app/api/product/index.py
def GET(request):
data = {}
for key,value in request.args.items():
data[key] = value
return {"query":data}
Enjoy your full-stack development experience with Python and React!
Using styled-components
Inside your root layout.jsx
define getAppContext function
import { ServerStyleSheet } from 'styled-components';
async getAppContext = (ctx)=>{
const sheet = new ServerStyleSheet();
ctx.renderApp:()=>({
enhanceApp:(App)=>App,
getStyles:(App)=>sheet.collectStyles(App),
styles:()=>sheet.getStyleTags(),
finally:()=>{
sheet.seal()
}
})
return ctx
}
Using Theme
Inside your root layout.jsx
import React from "react";
import { Outlet } from "react-router-dom";
import { ThemeProvider } from "src/libs/theme-provider"
function Layout(props) {
return (
<ThemeProvider attribute="class" defaultTheme="light" enableSystem>
<div className="p-0 m-0 dark:bg-gray-800 dark:text-white">
{/* Layout component */}
<Outlet />
</div>
</ThemeProvider>
)
}
Add Meta Data
# add the below in your index.py file
def meta_data():
return {
"title": "Ginger-Js",
"description": "Some Description",
"og:description": "Description Here",
"icon":"/static/images/favicon.ico"
}
Using this project locally
Clone this repo and run
pip install absolute/relative/path/to/repo
Project details
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 ginger_js-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fd7fab728651255b2c616932cf39643a865a5bd5e7475e20907accae410359cf |
|
MD5 | 5e5efc19fc217cfe2a8a018ac2fa9986 |
|
BLAKE2b-256 | d4508fee386d87549507c8e1771e385b6ea32e9d16eb8171e993ac1e79bc0e21 |