diff --git a/README.md b/README.md index 4351cff..fe6a05e 100644 --- a/README.md +++ b/README.md @@ -55,12 +55,9 @@ - TypeScript React Plugin (vscode-typescript-nextjs-plugin) - ESLint - Tailwind CSS IntelliSense -- Prettier -2. 安装 Bun 参照 https://bun.com/docs/installation#windows 官方文档命令 - 使用方式: -1. 拉取本项目 +1. 拉取本项目,安装依赖包 bun install 2. 创建环境变量文件 .env,复制 .env.example 中的内容到 .env,并根据实际情况修改 3. 运行 bun run dev 4. 上传代码到git master分支上直接使用vscode上传或者git命令: @@ -84,6 +81,43 @@ #### 上传到线上操作 +#### 目录结构 + +├── node_modules/ # 项目依赖包 +├── public/ # 静态资源(如 favicon、图片等,可直接通过根路径访问) +├── src/ # 源代码目录 +│ ├── actions/ # 服务端操作或 API 逻辑(如 Server Actions) +│ ├── app/ # Next.js 13+ App Router 目录,存放页面、布局、路由等 +| | ├── (api)/ # API 路由目录 +| | ├── (auth)/ # 认证相关页面 +| | ├── (home)/ # 首页模块 +| | ├── admin/ # 管理后台模块 +| | ├── effects.tsx # 全局副作用/状态管理(如 Redux、SWR 初始化) +| | ├── favicon.ico # 网站图标 +| | ├── globals.css # 全局样式 +| | └── layout.tsx # 根布局组件(所有页面共享的布局结构) +| | +│ ├── assets/ # 项目资源文件(如图片、字体、样式等) +│ ├── components/ # 可复用的 React 组件 +│ ├── lib/ # 工具函数、配置、服务等 +│ ├── mdx-components.tsx # MDX 组件配置 +│ └── proxy.ts # 代理配置(如 API 代理) +├── .dockerignore # Docker 忽略文件 +├── .env # 环境变量文件 +├── .gitignore # Git 忽略文件 +├── .npmrc # npm 配置 +├── bun.lock # Bun 包管理器锁文件 +├── components.json # 组件库配置(如 shadcn/ui) +├── Dockerfile # Docker 构建配置 +├── eslint.config.mjs # ESLint 代码检查配置 +├── next-env.d.ts # Next.js 类型声明 +├── next.config.ts # Next.js 配置文件 +├── package.json # 项目依赖和脚本 +├── postcss.config.mjs # PostCSS 配置 +├── publish.ps1 # PowerShell 发布脚本 +├── README.md # 项目说明文档 +└── tsconfig.json # TypeScript 配置 + ## 项目使用到的技术栈: #### 核心框架: