Skip to content

快速开始

本指南帮助您在 5 分钟内 完成后端服务 youlai-django(Python/Django)的启动和验证。

前置条件

必需环境

环境版本要求下载地址
Python3.12+Python官网
MySQL5.7+ / 8.x安装教程
Redis7.x安装教程

开发工具(可选)

  • PyCharm(推荐)
  • Visual Studio Code + Python 插件

项目结构

youlai-django/
├── config/                   # 项目配置
│   ├── settings/             # 环境配置
│   │   ├── base.py           # 通用配置
│   │   ├── dev.py            # 开发配置
│   │   └── prod.py           # 生产配置
│   └── urls.py               # 全局路由
├── core/                     # 公共基础能力
├── system/                   # 系统核心模块
├── sql/                      # 数据库脚本
│   └── mysql/
│       └── youlai_admin.sql  # 初始化脚本
├── requirements.txt          # Python 依赖
└── manage.py                 # Django 入口

安装步骤

数据库初始化

执行数据库脚本:

bash
mysql -u root -p < sql/mysql/youlai_admin.sql

配置修改

修改 config/settings/dev.py

数据库配置

python
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'HOST': 'localhost',
        'PORT': 3306,
        'NAME': 'youlai_admin',
        'USER': 'root',
        'PASSWORD': 'your_password',
    }
}

Redis配置

python
CACHES = {
    'default': {
        'BACKEND': 'django.core.cache.backends.redis.RedisCache',
        'LOCATION': 'redis://localhost:6379/0',
    }
}

JWT配置

python
SIMPLE_JWT = {
    'SIGNING_KEY': 'your-secret-key-at-least-32-characters-long',
    'ACCESS_TOKEN_LIFETIME': timedelta(hours=2),
}

安装依赖并启动

bash
python -m venv venv
source venv/bin/activate  # Linux/macOS
# venv\Scripts\activate  # Windows
pip install -r requirements.txt
python manage.py runserver 0.0.0.0:8000

启动成功标志:

Starting development server at http://0.0.0.0:8000/

快速验证

接口文档

访问 Swagger 文档:

http://localhost:8000/swagger/

登录测试

使用 Swagger 或 curl 测试登录接口:

bash
curl -X POST http://localhost:8000/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username":"admin","password":"123456"}'

成功响应:

json
{
  "code": "00000",
  "msg": "成功",
  "data": {
    "access": "eyJhbGc...",
    "refresh": "eyJhbGc...",
    "token_type": "Bearer",
    "expires_in": 7200
  }
}

前端联调

克隆前端项目

bash
git clone https://gitee.com/youlaiorg/vue3-element-admin.git
cd vue3-element-admin

配置后端地址

修改 .env.development

env
VITE_APP_API_URL=http://localhost:8000

启动前端

bash
pnpm install
pnpm run dev

访问 http://localhost:5173,使用以下账号登录:

  • 用户名:admin
  • 密码:123456

常见问题

端口冲突

解决方案:修改启动命令中的端口:python manage.py runserver 0.0.0.0:8001

数据库连接失败

排查步骤

  1. 确认 MySQL 服务已启动
  2. 检查数据库连接配置
  3. 确认数据库 youlai_admin 已创建

Redis 连接失败

排查步骤

  1. 确认 Redis 服务已启动:redis-cli ping
  2. 检查 Redis 连接配置

下一步

基于 MIT 许可发布