Contributing Guide

Overview

The packages directory houses multiple individual packages that are related to each other.

• @zeronejs/cli: Command line interface (CLI) module. Includes Zerone project creation, one-click generation of CURD, build and other functions.

• @zeronejs/role-easy: Simple role authorization module.

• @zeronejs/auth: Identity authentication module.

• @zeronejs/redis: Redis module.

• @zeronejs/utils: Tool function module.

Development Setup

Pre-requirement：

• Node.js version 16+
• pnpm

Clone the repo, and install dependencies：

pnpm i

Main tools that used in this project：

• TypeScript as the development language
• Jest for unit testing
• ESLint for code linting

Scripts

pnpm test

The test script uses Jest to run unit testings

pnpm commit

The commit command uses the message from git-cz when you commit code.

pnpm build

The build command uses zerone cli the build command.

Documentation

Source code is here

All the markdown source files are placed in docs directory. We are maintaining two translations:

• English (en-US) in / path
• Chinese (zh-CN) in /zh/ path

The production version we deployed on GitHub Pages.

The site is automatically built from the latest submission. The domain name is https://zerone.top.