前置准备
为了更好的开发体验,我们提供了一些工具配置、项目说明,以便于您更好的开发
为了更好的开发体验,我们提供了一些工具配置、项目说明,以便于您更好的开发。
需要掌握的基础知识
本项目是一个全栈项目,包含前端和后端两个部分,需要一定的前后端基础知识。请确保掌握相关技术栈的基础知识,以便能处理一些常见的问题。建议在开发前先学一下以下内容,提前了解和学习这些知识,会对项目理解非常有帮助:
前端技术栈 (Web)
核心框架:
- Vue 3 - 渐进式 JavaScript 框架
- Nuxt 3 - Vue.js 的直观全栈框架
- TypeScript - JavaScript 的超集,提供类型安全
样式和UI:
- Tailwind CSS - 原子化 CSS 框架
- @nuxt/ui - Nuxt UI 组件库
- Iconify - 图标框架
- Reka UI - Vue 组件库
状态管理和路由:
- Pinia - Vue 状态管理库
- Vue Router - Vue.js 官方路由
- VueUse - Vue Composition API 工具集
其他重要技术:
- Vue I18n - 国际化
- ECharts - 数据可视化图表库
- Markdown Editor - Markdown 编辑器
- Mermaid - 图表生成工具
后端技术栈 (Server)
核心框架:
- NestJS - 构建高效、可扩展的 Node.js 服务端应用框架
- TypeScript - JavaScript 的超集,提供类型安全
- Express - Node.js Web 应用框架
数据库和缓存:
- TypeORM - TypeScript 和 JavaScript 的 ORM
- PostgreSQL - 开源关系型数据库
- Redis - 内存数据结构存储,用作缓存和消息代理
认证和授权:
其他重要技术:
工具链
包管理和构建:
代码质量:
环境要求
基础环境
- Node.js: 22.x 或更高版本
- Pnpm: 9.x 或更高版本
- Git: 用于版本控制
数据库环境
- PostgreSQL: 14.x 或更高版本
- Redis: 6.x 或更高版本
开发工具
推荐使用以下开发工具:
- IDE: Visual Studio Code(推荐)
- 数据库管理: pgAdmin、DBeaver 或 Navicat
- API 测试: Postman 或 Insomnia
- 版本控制: Git + GitHub Desktop(可选)
工具配置
如果您使用的 IDE 是 VS Code(推荐)的话,可以安装以下工具来提高开发效率及代码格式化:
推荐插件
- Tailwind CSS IntelliSense - Tailwind CSS 提示插件
- CSS Variable Autocomplete - CSS 变量提示插件
- Iconify IntelliSense - Iconify 图标插件
- i18n Ally - 国际化插件
- Code Spell Checker - 单词语法检查
- DotENV - .env 文件高亮
- Thunder Client - API 测试工具
- GitLens - Git 增强工具
- Eslint - 代码质量检查