Skip to content

ChiefHYK/ai-reader

Repository files navigation

AI Reader App

一个基于AI大模型的智能听书应用,支持多种文本格式,提供个性化语音合成和学习计划管理功能。

功能特点

  • 支持多种文本格式(PDF, EPUB, TXT, RSS)
  • AI语音合成朗读
  • 自定义学习计划
  • 课程进度管理
  • 跨平台支持(iOS/Android)
  • 文本到语音功能
  • 用户注册和登录
  • 文本上传和语音合成
  • 阅读历史记录
    • 记录阅读文本内容
    • 记录阅读时长
    • 查看历史记录列表

功能更新

  • 阅读历史界面
    • 显示阅读记录列表
    • 包含标题、时长和日期信息
    • 支持点击查看详情(待实现)
  • 阅读历史详情页面
    • 显示详细的阅读信息
    • 包含阅读时间、持续时间
    • 显示完整的文本内容
    • 支持返回列表页面
  • 课程管理功能
    • 创建新课程
    • 查看课程列表
    • 更新课程进度
    • 支持多种文件格式(PDF, EPUB, TXT, RSS)
  • 课程管理界面
    • 显示课程列表
    • 添加新课程
    • 显示课程进度
    • 支持多种课程类型
    • 课程详情页面
  • 课程详情页面
    • 显示课程基本信息
    • 显示进度条
    • 章节列表管理
    • 支持添加新章节
    • 章节播放功能(待实现)
  • 章节播放功能
    • 文本转语音播放
    • 播放/暂停/停止控制
    • 播放速度调节
    • 显示章节内容
    • 支持滚动阅读

前端功能

  • 实现用户注册、登录、信息显示、文本上传和文本到语音功能

后端服务

  • 实现用户注册、登录和信息获取API

环境要求

  • Flutter 3.x
  • Node.js 16+
  • MongoDB 4.4+
  • Docker (可选)

快速开始

安装依赖

  1. 克隆项目

    git clone https://github.com/ChiefHYK/ai-reader.git
    cd AI-READER
  2. 安装前端依赖

    cd frontend
    flutter pub get
  3. 安装后端依赖

    cd backend
    npm install

配置环境变量

  1. 后端配置
    cp backend/.env.example backend/.env
    编辑 .env 文件:
    MONGODB_URI=mongodb://localhost:27017/ai-reader
    JWT_SECRET=your_jwt_secret
    AI_API_KEY=your_ai_api_key
    

运行项目

  1. 启动后端服务

    cd backend
    npm run dev
  2. 运行前端应用

    cd frontend
    flutter run

开发指南

目录结构

请参考 design.md 文件了解详细的项目结构。

代码规范

前端遵循 Flutter 官方代码规范 后端使用 ESLint + Prettier 提交信息遵循 Conventional Commits 规范

测试

运行测试

  1. 前端测试

    cd frontend
    flutter test
  2. 后端测试

    cd backend
    npm run test

部署

Docker部署

  1. 构建像

    docker-compose build
  2. 启动服务

    docker-compose up -d
  3. 访问应用

    http://localhost:3000
    

贡献指南

  1. Fork 项目
  2. 创建特性分支
  3. 提交改动
  4. 推送到分支
  5. 创建 Pull Request

许可证

MIT License

联系方式

项目负责人: ChiefHYK Email: [email protected]

开发说明

  • Git 版本控制
    • 使用 master 作为主分支
    • 提交代码:git push origin master

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published