NovaStack

简体中文

English

简体中文

English

Appearance

NovaStack 项目说明文档 ​

欢迎使用 NovaStack 全栈开发框架！本文档将帮助您快速上手并了解如何使用本框架构建现代化应用程序。

环境要求 ​

在开始之前，请确保您的开发环境满足以下要求：

  • Node.js v16.0.0 或更高版本
  • PNPM v8.0.0 或更高版本
  • Git
  • 支持的操作系统：Windows、macOS、Linux

安装依赖 ​

克隆项目后，首先需要安装项目依赖：

bash
pnpm install

提示

首次安装可能需要几分钟时间，取决于您的网络环境和计算机性能。

环境配置 ​

项目使用 .env 文件进行环境配置。您可以复制 .env.example 文件并根据需要进行修改：

bash
cp .env.example .env

以下是一些重要的环境变量：

# 应用配置
APP_NAME=NovaStack
APP_ENV=development
APP_PORT=3000
APP_URL=http://localhost:3000

# 数据库配置
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=novastack
DB_USERNAME=root
DB_PASSWORD=

# API配置
API_PREFIX=/api

注意

请不要将包含敏感信息的 .env 文件提交到版本控制系统中。

数据库迁移 ​

如果您的项目使用数据库，需要运行迁移命令来设置数据库结构：

bash
pnpm run migrate

这将创建所有必要的表和初始数据。

启动开发服务器 ​

完成上述步骤后，您可以启动开发服务器：

bash
pnpm run dev

开发服务器启动后，您可以在浏览器中访问 http://localhost:3000 查看应用。

开发模式特性 ​

  • 热模块替换 (HMR)
  • 实时错误提示
  • 自动重载
  • 开发调试工具

常用命令 ​

项目提供了多个实用的 npm 脚本命令：

  • pnpm run lint - 运行 ESLint 检查代码规范
  • pnpm run format - 使用 Prettier 格式化代码
  • pnpm run typecheck - 运行 TypeScript 类型检查
  • pnpm run build - 构建生产环境应用
  • pnpm run start - 启动生产环境应用
  • pnpm run test - 运行单元测试

更多说明 ​

有关项目的更多详细信息，请参考：

  • README.md
  • API 文档
  • 源码注释