项目简介
本项目是一个基于FastAPI和Vue3的自动化任务管理系统,目标是打造一个高效的后台管理系统。它支持定时任务的创建、管理与执行,结合了Python的FastAPI框架和Vue3前端框架,运用多种数据库(MySQL、MongoDB、Redis)进行数据存储,同时支持IP地址查询和集成高德地图API。
项目的主要特性和功能
- 后端技术:采用Python3和FastAPI构建高效的后台接口,支持命令行工具Typer,集成MySQL、MongoDB和Redis进行数据存储。
- 前端技术:使用Vue3和Vite构建现代化前端界面,支持TypeScript和ES6+语法,集成Element - Plus组件库和高德地图API。
- 定时任务:借助APScheduler框架实现定时任务的管理和调度,支持多种数据库的集成。
- 自动化代码生成:支持接口CURD代码的自动生成,简化开发流程。
- Docker Compose部署:提供Docker Compose配置文件,便于在生产环境快速部署。
安装使用步骤
1. 环境准备
确保已安装以下软件: - Python 3.10 - Node.js >= 14.0 - MySQL >= 8.0 - MongoDB - Redis
2. 安装依赖
在项目根目录下执行以下命令安装后端依赖:
bash
pip3 install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple/
3. 配置数据库
在application/config
目录中,根据开发或生产环境复制并修改相应的配置文件(如development_example.py
或production_example.py
),删除_example
后缀并填写数据库连接信息。
4. 创建数据库
在MySQL中创建数据库并设置编码:
sql
mysql> create database sakura_k;
mysql> use sakura_k;
mysql> set names utf8;
5. 初始化数据库数据
在项目根目录下执行以下命令初始化数据库:
bash
python3 main.py init --env dev
6. 启动项目
启动后端服务:
bash
python3 main.py run
启动定时任务:
bash
python3 /utils/tasks/run.py run
7. 前端项目打包
进入前端项目目录并执行以下命令:
bash
cd kinit-admin
pnpm install
pnpm run build:pro
8. Docker Compose部署
使用Docker Compose启动并初始化项目:
bash
docker-compose up -d
docker-compose exec kinit-api python3 main.py init
docker-compose restart
9. 访问项目
- 访问地址:http://localhost
- 接口文档地址:http://localhost:9000/docs
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】