create-nicsde-next-app/README.MD

A CLI tool to create Next.js applications with custom configurations

<!--
 * @Author: xiaohang 472843286@qq.com
 * @Date: 2025-04-11 16:13:01
 * @LastEditors: xiaohang 472843286@qq.com
 * @LastEditTime: 2025-07-23 15:17:04
 * @FilePath: /create-nicsde-next-app/README.MD
 * @Description: 这是默认设置,请设置`customMade`, 打开koroFileHeader查看配置 进行设置: https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE
-->

# create-nicsde-next-app [![npm version](https://img.shields.io/npm/v/create-nicsde-next-app.svg?style=flat)](https://www.npmjs.com/package/create-nicsde-next-app)

Next.js 脚手架工具项目指引

#### **项目概述**
这是一个定制化的 Next.js 项目生成工具（CLI），用于快速创建预配置的企业级 Next.js 应用，包含：
- TypeScript + Turbo 集成
- TailwindCSS 样式方案
- 标准化 Docker 部署配置
- 预设的工程化规范（ESLint/Prettier）
- 提供同济大学统一身份认证登录

---

### **🛠️ 开发者指南**

#### 1. 环境要求
- Node.js ≥20
- npm ≥9 或 yarn ≥1.22

#### 2. 核心命令
| 命令 | 功能 |
|------|------|
| `node index.js <项目名>` | 创建新项目（开发模式） |
| `npm link` | 全局安装工具（需管理员权限） |
| `npm unlink create-nicsde-next-app` | 全局安装工具（需管理员权限） |
| `create-nicsde-next-app <项目名>` | 全局安装后使用 |

---

### **📦 安装与使用**

#### 全局安装
```bash
npm install -g create-nicsde-next-app
```

#### 创建新项目
```bash
create-nicsde-next-app my-project
```

### **🚀 生成项目特性**
生成的 Next.js 项目将包含以下预设：
- **技术栈**  
  ```markdown
  - Next.js v15+
  - TypeScript 5.x
  - TailwindCSS 3.x
  - Turbo 加速构建
  ```

- **工程化配置**  
  ```markdown
  - ESLint（严格模式 + TS支持）
  - Prettier（2空格缩进 + 单引号）
  ```

- **部署就绪**  
  ```markdown
  - 优化过的 Dockerfile
  - 多阶段构建配置
  - Nginx 生产环境配置
  ```

---

### **📁 项目结构说明

### **🔄 发布与更新**

#### 发布新版本
1. 更新版本号
```bash
npm version patch|minor|major
```
2. 发布到npm
```bash
npm publish
```
```
create-nicsde-next-app/
├── src/app/         # Next.js 应用路由
└── public/          # 静态资源
├── index.js            # CLI 主逻辑
├── .eslintrc.js        # 代码质量规则
└── .prettierrc         # 代码风格配置
└── .eslintrc.js        # eslintrc配置
└── .npmrc              # .npmrc配置
```