Django-React-TyAdmin快速入门指南

最新推荐文章于 2024-12-09 12:05:35 发布

卓炯娓

最新推荐文章于 2024-12-09 12:05:35 发布

阅读量496

点赞数 4

本文链接：https://blog.csdn.net/gitblog_00223/article/details/142477617

版权

Django-React-TyAdmin快速入门指南

django-react-tyadmin 支持Python3.9,Django4! 类似 xadmin 的基于Model 快速生成前后台管理增删改查，筛选，搜索的后台管理自动化工具。Antd 界面好看现代化！前后端分离！无损二次开发！由Django Restful Framework 和 Ant Design Pro V4 驱动项目地址: https://gitcode.com/gh_mirrors/dj/django-react-tyadmin

项目概述 Django-React-TyAdmin 是一个高效的后台管理系统框架，专为追求快速开发且期望具备现代UI的企业级应用设计。该框架结合了Django的稳健后端与React的灵活前端，借助Ant Design Pro V4打造美观的界面，旨在减少开发者在常规管理界面编写上的时间和精力。

1. 项目目录结构及介绍

以下是django-react-tyadmin典型的项目结构概览：

django-react-tyadmin/
├── demos                            # 示例项目目录
│   ├── tyadmin_api_cli              # CLI工具相关的示例代码
│   └── tyadmin_demo_finish          # 完成状态的项目示例
├── django-react-tyadmin             # 主工程源码
│   ├── tyadmin_api                   # 后端管理接口App
│   ├── tyadmin                       # 前端构建项目
│   ├── requirements.txt             # 项目所需Python包列表
│   ├── setup.py                      # 项目安装脚本
│   └── ...                           # 其他配置文件和脚本
├── tests                             # 测试相关文件
├── CONTRIBUTING.md                  # 贡献指南
├── LICENSE                           # 许可证文件
└── README.md                         # 项目说明文档

demos: 包含快速上手所需的初始化项目和完成后的参考项目。
django-react-tyadmin: 核心源代码，分为前端(tyadmin)和后端(tyadmin_api)两大部分。
requirements.txt: 定义了项目的Python依赖。
setup.py: 用于设置和部署项目。

2. 项目的启动文件介绍

后端启动

主要文件: manage.py，位于项目根目录下，是启动Django服务器的主要入口点。

使用方法示例：在终端定位到项目根目录后，运行以下命令来启动开发服务器：
```
python manage.py runserver
```

前端启动

前端启动涉及到两个步骤，首先通过CLI工具生成前端代码，然后在tyadmin子目录下启动React应用。

在生成前端代码之后，进入tyadmin目录，执行以下命令启动前端应用：
```
npm install
npm start
```
这将在另一个端口（通常默认是8001）上运行前端应用程序。

3. 项目的配置文件介绍

后端配置 - `settings.py`

位置: django-react-tyadmin/django_project/settings.py

此文件包含了Django项目的大部分配置，包括数据库连接、中间件、应用程序安装、静态文件和模板路径等。对于TyAdmin特别重要的配置项包括添加'tyadmin_api_cli'到INSTALLED_APPS，以及配置TY_ADMIN_CONFIG来指定哪些Django apps需要生成管理界面。

前端配置 - `package.json`与`.env`

位置: tyadmin/package.json & .env（可能需要自己创建）

package.json定义了Node.js项目及其依赖，包括启动脚本。对于环境变量，.env文件可以用来存储前端构建或运行时需要的变量，比如API的基础URL，但注意这并非Django项目的直接配置部分。