McKay's App Template 使用教程

McKay's App Template 使用教程

mckays-app-template This is the template I use to start new full-stack projects. 项目地址: https://gitcode.com/gh_mirrors/mc/mckays-app-template

1. 项目目录结构及介绍

McKay's App Template 是一个全栈应用程序模板，适用于快速启动新的全栈项目。以下是项目的目录结构及各部分的介绍：

mckays-app-template/
├── .github/                       # GitHub 工作流和配置文件
├── .husky/                        # Husky 配置文件，用于 Git 钩子
├── actions/                       # GitHub Actions 工作流
├── app/                           # 应用程序的主要代码目录
│   ├── components/                # React 组件
│   ├── db/                        # 数据库相关文件
│   ├── hooks/                     # 自定义 React 钩子
│   ├── lib/                       # 公共库和工具
│   ├── prompts/                   # 交互式提示相关
│   ├── public/                    # 公共文件，如图片、样式表等
│   ├── types/                     # TypeScript 类型定义
│   ├── drizzle.config.ts          # Drizzle 配置文件
│   ├── middleware.ts              # 中间件配置
│   ├── next.config.mjs            # Next.js 配置文件
│   └── tsconfig.json              # TypeScript 配置文件
├── components.json               # 组件配置文件
├── drizzle.config.ts              # Drizzle 配置文件
├── .eslintrc.json                 # ESLint 配置文件
├── .gitignore                     # Git 忽略文件
├── .repo_ignore                   # Repo 忽略文件
├── .env.example                   # 环境变量示例文件
├── package-lock.json              # npm 锁定文件
├── package.json                   # npm 包配置文件
├── postcss.config.mjs             # PostCSS 配置文件
├── prettier.config.cjs            # Prettier 配置文件
├── tailwind.config.ts             # Tailwind CSS 配置文件
└── README.md                      # 项目说明文件

2. 项目的启动文件介绍

项目的启动主要通过 package.json 中的脚本来进行。以下是主要的启动脚本：

• npm install：安装项目依赖。
• npm run dev：启动本地开发服务器。

3. 项目的配置文件介绍

项目中有几个关键的配置文件，以下是对它们的简要介绍：

• .env.example：这个文件包含了所有需要在环境中设置的变量的示例。在实际部署时，需要将这个文件复制为 .env.local 并填入实际的值。
• drizzle.config.ts：Drizzle 是一个 ORM，用于处理数据库交互。这个文件配置了 Drizzle 与数据库的连接。
• next.config.mjs：Next.js 的配置文件，用于设置各种 Next.js 的行为，如路由、中间件等。
• tailwind.config.ts：Tailwind CSS 的配置文件，用于定制 Tailwind 的样式。

确保在开始项目之前正确配置这些文件，以便项目能够正常运行。

mckays-app-template This is the template I use to start new full-stack projects. 项目地址: https://gitcode.com/gh_mirrors/mc/mckays-app-template