快速上手

依赖环境

手动安装

这一章节会帮助你从头搭建一个简单的 Zerone 基础服务。

  • 步骤1: 安装Zerone cli工具并新建项目
npm i -g @zeronejs/cli
zerone new project-name
cd project-name
1
2
3
  • 步骤2: 安装依赖并运行
yarn
yarn start
1
2
npm install
npm run start
1
2

Zerone 会在 http://localhost:5000在新窗口打开 启动一个开发服务器。http://localhost:5000/docs在新窗口打开 启动一个 Swagger 开放api。

现在,你应该已经有了一个简单可用的 Zerone 服务器。

一键生成CURD

项目创建之后,会携带一个用户表,这一章节将帮助您一键生成接口

提示

generate 命令会读取当前目录下所有 *.entity.ts文件 的表结构在新窗口打开

需要您进入此文件夹

cd src/api/user/entities/
1

仅需一行命令,一套CRUD就生成了。

zerone generate
1

重启项目

yarn start
1
npm run start
1

http://localhost:5000/docs在新窗口打开 查看生成的接口

提示

本项目构建于typeorm, 如有表关联等个性化需求,请参考typeorm在新窗口打开

数据后台

打开http://localhost:5000/admin在新窗口打开查看启动的数据后台。

提示

可直接点击登录。 配置文件在 src/common/admin/adminOption.ts