Skip to content

Repository files navigation

AI Overview 项目

AI Overview 是一个综合性人工智能技术概览与学习平台,旨在帮助开发者、研究者和AI爱好者了解和掌握最新的人工智能技术、应用和趋势。

项目结构

ai-overview
├── .github/workflows/     # GitHub Actions 工作流配置
│   ├── frontend-ci.yml    # 前端CI流程
│   └── backend-cd.yml     # 后端部署流程
├── frontend/              # 前端项目 (Next.js)
│   ├── public/            # 静态资源
│   ├── src/               # 前端源代码
│   │   ├── app/           # 应用组件
│   │   ├── components/    # 通用组件
│   │   ├── lib/           # 工具库
│   │   └── styles/        # 样式文件
│   ├── .env.example       # 环境变量示例
│   ├── README.md          # 前端项目说明
├── backend/               # 后端项目 (Spring Boot)
│   ├── .dockerignore      # Docker忽略配置
│   ├── Dockerfile         # 后端Docker配置
│   ├── Makefile           # 构建脚本
│   ├── ai-demo/           # 后端主应用
│   ├── doc/               # 后端文档
│   └── pom.xml            # 父级Maven配置
├── doc/                   # 项目文档
├── .gitignore             # Git忽略配置
├── README.md              # 项目总说明

技术栈

前端

  • 框架: Next.js 14 (React 18)
  • 构建工具: Webpack, Babel
  • 样式: Tailwind CSS 3
  • 类型检查: TypeScript
  • 包管理器: pnpm
  • 代码规范: ESLint

后端

  • 框架: Spring Boot 3
  • 构建工具: Maven
  • 容器化: Docker

开发与部署

  • 版本控制: Git
  • CI/CD: GitHub Actions
  • 前端部署: Vercel

快速开始

前提条件

克隆仓库

首先克隆项目代码:

# 克隆仓库
git clone https://github.com/yourusername/ai-overview.git
cd ai-overview

单独启动开发环境

前端开发

cd frontend
pnpm install
pnpm run dev

前端服务将在 http://localhost:3010 启动。

后端开发

切换到 backend 目录

cd backend
  1. 首次使用项目
make env-init
# 编辑 .env 文件设置 DEEPSEEK_API_KEY
make check-env
make docker-compose-up-build
  1. 日常开发流程
# 修改代码后
git add .
git commit -m "修改说明"
make docker-compose-up-build  # 智能构建并启动
make docker-compose-status    # 检查服务状态
make docker-compose-logs      # 查看日志


后端服务将在 http://localhost:8090 启动。

## 功能特性

### 前端功能
- 响应式设计,支持各种设备
- 现代化UI,基于Tailwind CSS
- 动态路由和页面过渡
- API请求代理和数据获取
- 用户认证和授权

### 后端功能
- RESTful API 设计和实现
- 用户管理和认证系统
- 数据持久化和查询
- 安全控制和权限管理
- API文档 (通过Swagger)

## 开发指南

### 代码规范
- 前端: 遵循 ESLint 和 TypeScript 规范
- 后端: 遵循 Spring Boot 最佳实践

## CI/CD 流程

项目使用 GitHub Actions 实现自动化的 CI/CD 流程:

- **前端 CI**: 当推送到 main 分支或创建 PR 时,自动运行 lint、测试和构建
- **后端 CD**: 当推送到 main 分支时,自动构建、测试、打包 Docker 镜像并部署

## 文档

项目文档位于 `docs/` 目录,包括:
- 系统架构设计
- API 文档
- 数据库设计
- 开发指南

## 贡献

欢迎贡献代码!请按照以下流程:
1. Fork 仓库
2. 创建功能分支
3. 提交更改
4. 创建 PR

## 许可

本项目使用 MIT 许可证 - 详情请查看 [LICENSE](LICENSE) 文件。

## 联系方式

如有任何问题或建议,请提交GitHub Issue或联系项目维护者。

About

ai知识库

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages