## 环境准备
* 操作系统:支持 macOS,Windows
* 运行环境:node >= 12.18.4
<br>
## 快速构建项目
推荐使用脚手架快速初始化项目。( 科学上网会安装的更快 )
通过下方的命令全局安装脚手架
```
npm install think-js-cli -g
```
然后通过 ``think-js-cli init <项目名称>`` 命令初始化项目
```
think-js-cli init project-name
```
![](https://img.kancloud.cn/a4/9b/a49b157a2aa0113fb08f13f945cda855_640x413.png)
<br>
输入 ``Y`` 之后通过上下键选择框架类型
基础框架是纯净版,不含用于演示功能的业务逻辑,根据情况选择对应的框架
![](https://img.kancloud.cn/91/fc/91fc517356c5b75cccbcc3775d9897fb_631x415.png)
<br>
接着在项目目录下通过 ``pnpm install`` 将项目所需要的依赖安装上 (推荐使用 pnpm)
<br>
启动项目:
```
pnpm run dev
```
> 注意:在开发环境下使用该命令启动可以实时查看框架的输出信息,生产环境请使用 ``npm start`` 命令启动到 ``pm2`` 上管理
> 注意:程序默认运行在 ``5985`` 端口下,如果项目启动时提示端口占用,请通过 ``config/app.js`` 配置文件修改端口,或者杀掉占用的进程
![](https://img.kancloud.cn/6a/05/6a051c6459e8c2978821e909bbf766a3_625x399.png)
- 序言
- 新手指南
- 安装
- 开发规范
- 目录结构
- 配置
- 路由
- 路由定义
- 路由中间件
- 控制器
- 控制器定义
- 内置showSuccess方法
- 内置ApiException方法
- 参数获取器getParams
- 网络请求器Fetch
- 内置工具函数
- JWT的使用
- 验证
- 验证器
- 验证规则
- 自定义验证规则
- 混合验证规则
- 分场景验证
- 数据库
- 连接数据库
- 查询数据
- 链式操作
- where
- whereOr
- whereBetweenTime
- limit
- page
- count
- order
- field
- alias
- group
- distinct
- 添加数据
- 更新数据
- 删除数据
- 联表查询
- SQL调试
- 模型
- 视图
- 模板渲染(废弃)
- 模板变量(废弃)
- 错误和日志
- 异常处理
- 日志处理
- 命令行
- 扩展库
- 使用Redis
- get
- set
- del
- hget
- hset
- hdel
- decrby
- incrby
- rpush
- rpop
- 使用MongoDB
- 模型
- 新增
- 删除
- 修改
- 查询
- 使用ElasticSearch
- 使用阿里云OSS
- 阿里短信服务
- 微信支付
- 支付宝支付
- 部署
- 更新日志