# nextjs13-tailwind-template

**Repository Path**: kongxm/nextjs13-tailwind-template

## Basic Information

- **Project Name**: nextjs13-tailwind-template
- **Description**: Next.js 13+、TypeScript、Tailwind CSS、Turbopack
- **Primary Language**: JavaScript
- **License**: Unlicense
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 3
- **Created**: 2024-01-25
- **Last Updated**: 2024-01-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# nextjs13-template

## 项目信息

- 【暂无】

## 分支规则说明

- master 分支为最新稳定版本的代码
- dev 分支项目负责人才有合并权限
- 其他开发成员分支命名规则为 dev-feat-xxx，xxx 代表开发者名称拼音小写首字母
- 开发版本分支名称 v1.0-dev
- 发布版本分支名称 v1.0-release
- 每个版本封版后需要打一个 tag

## 目录说明

- .husky: git hooks
- api: 项目 api 相关文件、请求封装
- app: 项目页面入口
- coponents: 项目公用组件，纯粹一点的组件，无强制性的业务关联逻辑和代码
- features: 项目公用业务模块，可内置接口请求、type 等
- hooks: 项目公用 hooks
- public: 公共静态资源
- styles: 项目公用样式、动画、主题、变量等
- types: 项目公用的一些 type
- utils: 项目公用工具类、格式化、常量等
- web3: 项目公用 web3 相关类和方法

## Commit 规范

<type>(<scope>): <subject>
type: 类型

```
 * feat：新增功能
 * fix：bug 修复
 * docs：文档更新
 * style：不影响程序逻辑的代码修改(修改空白字符，格式缩进，补全缺失的分号等，没有改变代码逻辑)
 * refactor：重构代码(既没有新增功能，也没有修复 bug)
 * perf：性能, 体验优化
 * test：新增测试用例或是更新现有测试
 * build：主要目的是修改项目构建系统(例如 glup，webpack，rollup 的配置等)的提交
 * ci：主要目的是修改项目继续集成流程(例如 Travis，Jenkins，GitLab CI，Circle等)的提交
 * chore：不属于以上类型的其他类型，比如构建流程, 依赖管理
 * revert：回滚某个更早之前的提交
```

scope: 可选,影响范围
subject: 对 commit 的简短描述

## Build Setup

```bash
# install dependencies
yarn install

# start dev

yarn dev

# build production
yarn build
```

## 引入新的 npm 包

- devDependencies 预编译时用到的模块，生产环境用不上
  `npm install --save-dev moduleName` or `yarn add -D moduleName`
- dependencies 实际运行时要用到的模块，生产环境也要用到
  `npm install --save moduleName` or `yarn add moduleName`

## 开发概要

- Next.js 13+
- TypeScript
- Turbopack
- Tailwind CSS
- 团队规范
  eslint
  husky
  .vscode