https://github.com/bigrivi/black-panther
Full stack web application scaffold,Using FastAPI,BetterCRUD,Refine and more.
https://github.com/bigrivi/black-panther
admin-ui bettercrud fastapi fullstack-development low-code material-ui python react refine
Last synced: 2 months ago
JSON representation
Full stack web application scaffold,Using FastAPI,BetterCRUD,Refine and more.
- Host: GitHub
- URL: https://github.com/bigrivi/black-panther
- Owner: bigrivi
- License: mit
- Created: 2025-04-06T13:02:13.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-30T00:51:43.000Z (11 months ago)
- Last Synced: 2025-07-30T02:56:40.001Z (11 months ago)
- Topics: admin-ui, bettercrud, fastapi, fullstack-development, low-code, material-ui, python, react, refine
- Language: TypeScript
- Homepage:
- Size: 5.03 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Full-stack Web application scaffolding,low-code builder, the perfect combination of Refine and BetterCRUD
**BlackPanther** is a complete full-stack web application scaffolding that uses FastAPI, BetterCRUD, Refine, and more.
He has defined a set of good front-end and back-end development best practices to quickly develop products such as CRM, CMS, Admin Dashboard and other different types of management systems
At the same time, **BlackPanther** is also a low-code builder that provides a series of low-code components and solutions
I like [Refine](https://refine.dev/) very much, I think it's a good solution for the front-end to produce products quickly, and I have always hoped that Refine can be combined with [BetterCRUD](https://github.com/bigrivi/better_crud) to generate strong productivity, which is also the original intention of this project
⭐ If you find BlackPanther useful, please consider giving us a star on GitHub! Your support helps us continue to innovate and deliver exciting features.
## Technology Stack
- ⚡ [**FastAPI**](https://fastapi.tiangolo.com) for the Python backend API.
- ✒️ [BetterCRUD](https://github.com/bigrivi/better_crud) Quickly implement CRUD functions
- 🧰 [SQLModel](https://sqlmodel.tiangolo.com) for the Python SQL database interactions (ORM).
- 🔍 [Pydantic](https://docs.pydantic.dev), used by FastAPI, for the data validation and settings management.
- 🚀 [React](https://react.dev) for the frontend.
- 🐱 Using TypeScript, hooks, Vite, and other parts of a modern frontend stack.
- ☣️ [Refine](https://refine.dev/) for the frontend CRUD pages.
- 🔷 [Material UI](material-ui.com) for the frontend ui components.
- 🐩 [Material React Table](https://www.material-react-table.com/) for the list page tables
- 💅 [react-hook-form-mui](https://github.com/dohomi/react-hook-form-mui) for the create/edit page forms
## All features
- 🎁 **Very nice front-end UI interface**:Thanks to the appearance of Material UI
- 🔑 **JWT** (JSON Web Token) authentication.
- 🔒 **Secure** password hashing by default.
- 🐼 **Login Authorization**
- 🐎 **Role-Based Access Control**:Powerful role-based asset action control
- 🐥 **Multi-language support**
- 🎓 **Dark mode support**
- 🎉 **Built-in Module**
- 💿 **User Management**
- 🎇 **Role Management**
- 🎃 **Position Management**
- 🔦 **Department Management**
- 📲 **Resource Management**
- 🔈 **Policy**
- 🏠 **Enum Management**
- 🌠 **Parameter setting**
- 🎁 **Dynamic module**
### Login
### Policy
### User
1. List
2. Create
### Role
1. List
2. Create
### Resource
1. List
2. Create
### Department
1. List
2. Create
### Enum
1. List
2. Edit
#### Sidebar mini mode
#### Chinese Simplified switch
#### Dark mode
### Dynamic module support
Compared with other features, this is a dessert-level feature 😃 👍
**Generate the front end through SQLModel model configuration**
>Zero code on the front end
Just define some special fields to describe the data in your backend model, and the frontend will be automatically generated.
This method is more suitable when you have a large number of data tables to maintain and there is not much complex business logic.
```python
from typing import Optional, List
from datetime import datetime
from sqlmodel import SQLModel, Relationship, BIGINT
from app.common.model import BaseMixin
from app.common.model.field import Field
from app.common.model.helper import partial_model
from app.enums import IntNameEnum
from app.modules.department.models import Department, DepartmentPublic
from app.modules.position.models import Position, PositionPublic
from .detail.models import ToyDetail, ToyDetailCreate, ToyDetailPublic
from app.modules.role.models import Role, RolePublicWithoutActions
class ToyRoleLink(SQLModel, table=True):
__tablename__ = "toy_role_link"
id: int = Field(
sa_type=BIGINT,
primary_key=True,
index=True,
nullable=False,
)
toy_id: Optional[int] = Field(
default=None, sa_type=BIGINT, foreign_key="toy.id"
)
role_id: Optional[int] = Field(
default=None, sa_type=BIGINT, foreign_key="role.id"
)
class Select1Enum(IntNameEnum):
option1 = 1, "option1"
option2 = 2, "option2"
option3 = 3, "option3"
class ToyBase(SQLModel):
tetx1: str = Field(value_type="text",
title="text1", description="description")
tetx2: str = Field(default=None, value_type="text", title="text2")
textarea1: Optional[str] = Field(
default=None, value_type="textarea", title="textarea1")
switch1: Optional[bool] = Field(
default=True, value_type="switch", title="switch1", description="description")
checkbox1: Optional[bool] = Field(
default=True, value_type="checkbox", title="checkbox1", description="description")
select1: Select1Enum | None = Field(
enum=Select1Enum, default=Select1Enum.option1, value_type="select", title="select1", description="select1_description")
department_id: Optional[int] = Field(
default=None,
title="department",
value_type="referenceNode",
sa_type=BIGINT,
reference="department",
hide_in_list=True,
foreign_key="department.id",
description="department_description"
)
position_id: int = Field(
foreign_key="position.id",
title="position",
value_type="reference",
sa_type=BIGINT,
reference="position",
hide_in_list=True,
priority=10
)
class Toy(ToyBase, BaseMixin, table=True):
department: Optional[Department] = Relationship(
sa_relationship_kwargs={"lazy": "noload"},
)
position: Optional[Position] = Relationship(
sa_relationship_kwargs={"lazy": "noload"},
)
details: List[ToyDetail] = Relationship(
sa_relationship_kwargs={
"uselist": True,
"cascade": "all, delete-orphan",
"lazy": "noload"
})
roles: List["Role"] = Relationship(
sa_relationship_kwargs={"lazy": "noload"},
link_model=ToyRoleLink
)
class ToyPublic(ToyBase):
id: Optional[int]
department: Optional[DepartmentPublic] = Field(
title="department",
value_type="referenceNode",
reference="department",
search_key="department_id"
)
position: Optional[PositionPublic] = Field(
title="position",
value_type="reference",
reference="position",
search_key="position_id",
priority=10
)
created_at: Optional[datetime] = None
details: List[ToyDetailPublic] = None
roles: List[RolePublicWithoutActions] = Field(
title="roles",
value_type="referenceArray",
reference="role",
priority=9
)
class ToyCreate(ToyBase):
roles: Optional[List[int]] = Field(
default=None,
title="roles",
value_type="referenceArray",
reference="role",
priority=9
)
details: List[ToyDetailCreate] = Field(
title="details", value_type="listTable", description="detail description")
@partial_model
class ToyUpdate(ToyBase):
roles: Optional[List[int]] = Field(
default=None,
title="roles",
value_type="referenceArray",
reference="role",
priority=9
)
details: List[ToyDetailCreate] = None
```
The front end automatically generates lists and forms based on the json schema returned by the back end
### Support for relationships
#### 1. One To One
Create/Edit Mode
```python
department_id: Optional[int] = Field(
default=None,
title="department",
value_type="referenceNode",
sa_type=BIGINT,
reference="department",
hide_in_list=True,
foreign_key="department.id",
description="department_description"
)
position_id: int = Field(
foreign_key="position.id",
title="position",
value_type="reference",
sa_type=BIGINT,
reference="position",
hide_in_list=True,
priority=10
)
```
Add value_type and reference attributes to the normal SQLModel foreign key configuration
Different value_type will present different form rendering items
**reference**:autocomplete.
**referenceNode**:tree select.
Also in list mode you only need to configure
```python
department: Optional[DepartmentPublic] = Field(
title="department",
value_type="referenceNode",
reference="department",
search_key="department_id"
)
position: Optional[PositionPublic] = Field(
title="position",
value_type="reference",
reference="position",
search_key="position_id",
priority=10
)
```
#### 2. One To Many
```python
class ToyCreate(ToyBase):
details: List[ToyDetailCreate] = Field(title="details", value_type="listTable", description="detail description")
```
Compared with the normal **SQLModel** relationship configuration
You just should to add value_type as listTable
The front end will automatically generate one-to-many table data maintenance
#### 3. Many To Many
```python
class ToyRoleLink(SQLModel, table=True):
__tablename__ = "toy_role_link"
id: int = Field(
sa_type=BIGINT,
primary_key=True,
index=True,
nullable=False,
)
toy_id: Optional[int] = Field(
default=None, sa_type=BIGINT, foreign_key="toy.id"
)
role_id: Optional[int] = Field(
default=None, sa_type=BIGINT, foreign_key="role.id"
)
class Toy(ToyBase, BaseMixin, table=True):
roles: List["Role"] = Relationship(
sa_relationship_kwargs={"lazy": "noload"},
link_model=ToyRoleLink
)
class ToyCreate(ToyBase):
roles: Optional[List[int]] = Field(
default=None,
title="roles",
value_type="referenceArray",
reference="role",
priority=9
)
```
Compared with the normal **SQLModel** relationship configuration
You just should to add value_type as referenceArray
The front end will automatically generate a multi-select autocomplate control
## How To Use It
You can **just fork or clone** this repository and use it as is.
✨ It just works. ✨
## Backend Development
Backend docs: [backend/README.md](./backend/README.md).
## Frontend Development
Frontend docs: [frontend/README.md](./frontend/README.md).
## Why did you use BlackPanther as the name of the project?
Black Panther is the name of a stray cat I feed. It is very cute and obedient. We have a good relationship. My daughter gave it the name, which I think is good. I hope it can live a good life.
## Off Topic
I really want to thank this project. In the loneliest moments of my life, it has always motivated me to move forward and complete these features with a high pursuit as my goal.
## Author
👤 **bigrivi**
* GitHub: [bigrivi](https://github.com/bigrivi)
## 🤝 Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
[MIT](LICENSE)