贡献指南

概览

在 packages 目录下存放了多个互相关联的独立 Package 。

• @zeronejs/cli: 命令行接口 (CLI) 模块。包含创建 Zerone 项目，一键生成 CURD ，build 等功能。

• @zeronejs/role-easy: 简单的角色授权模块。

• @zeronejs/auth: 身份认证模块。

• @zeronejs/redis: redis模块。

• @zeronejs/utils: 工具函数模块。

开发配置

开发要求：

• Node.js version 16+
• pnpm

克隆代码仓库，并安装依赖：

pnpm i

本项目开发使用的一些主要工具：

• TypeScript 作为开发语言
• Jest 用于单元测试
• ESLint 用于代码检查

开发脚本

pnpm test

test 命令使用 Jest 来运行单元测试。

pnpm commit

commit 命令使用 git-cz ,在您进行代码提交时的消息。

pnpm build

build 命令使用 zerone cli build命令 。

文档

源码在这里

所有的 Markdown 源文件都放置在 docs 目录下。我们维护了两种翻译：

• 英语 (en-US) 在 / 路径下
• 中文 (zh-CN) 在 /zh/ 路径下

我们在 GitHub Pages 部署的 生产 版本。该站点是从最新的提交中自动构建而来。域名为 https://zerone.top。