项目结构

本文档概述了 NuxSaaS 项目中的主要目录和文件。旨在帮助贡献者和用户快速了解代码库的组织结构。

顶层布局

NuxSaaS/
├── .env.example
├── .github/
├── .vscode/
├── app/
├── public/
├── server/
├── tests/
├── eslint.config.mjs
├── nuxt.config.ts
├── package.json
├── tsconfig.json
├── vitest.config.ts
└── wrangler.example.toml

目录和文件概述

.env.example

环境变量模板。复制并重命名为 .env 用于本地设置。

.github/

GitHub 配置文件，例如赞助和工作流定义。

.vscode/

VS Code 工作区设置、扩展推荐和调试配置。

app/

包含所有前端应用程序代码：

• app.vue, app.config.ts: Nuxt 应用程序的主要入口和配置。
• assets/: 静态资源（CSS、图片等）。
• components/: Vue 组件。
• composables/: 可重用的组合式 API 工具。
• i18n/: 国际化资源。
• layouts/: 不同页面结构的布局组件。
• middleware/: 前端路由中间件。
• pages/: Nuxt 页面，映射到路由。
• plugins/: 用于扩展应用程序功能的 Nuxt 插件。
• utils/: 工具函数和类型定义。

public/

在站点根目录提供的静态文件，例如网站图标、徽标和屏幕截图。

server/

后端/服务器端代码：

• api/: API 路由处理程序。
• database/: 数据库配置和模式。
• middleware/: 服务器中间件。
• utils/: 服务器端工具。

tests/

自动化测试文件，包括端到端 (e2e) 测试和设置脚本。

eslint.config.mjs

ESLint 配置文件，用于代码检查和样式强制。

nuxt.config.ts

主要的 Nuxt 配置文件，定义模块、插件、运行时设置等。

package.json

项目元数据、脚本和依赖项。

tsconfig.json

整个项目的 TypeScript 配置。

vitest.config.ts

Vitest 测试框架的配置。

wrangler.example.toml

使用 Wrangler 部署到 Cloudflare Workers 的示例配置。

---

有关开发工作流程、环境设置和推荐工具的更多详细信息，请参阅此目录中的其他指南。