Skip to content

Latest commit

 

History

History
72 lines (43 loc) · 2.25 KB

README.md

File metadata and controls

72 lines (43 loc) · 2.25 KB

Create JavaScript Lib Starter

LICENSE LAST COMMIT Commitizen friendly Codacy Badge

English | 简体中文

This is a startup development configuration template used to build the JavaScript/Node.js library.

Templates

The following templates are provided here:

Usage

  1. There are two ways to use this template:

    • Open GitHub Repository Website, then Click Use this template Button.

    • Another way, clone to local

      git clone https://github.com/wang1212/create-lib-starter.git
  2. Then, select any template type you want to use, copy the contents of its folder(./templates/*) to the project root directory, and delete the templates/ folder.

    • Choose an open source license.

    • Modify package.json information, such as name, description, etc.

    • Set the remote address of the github repository to your own:

      git remote set-url origin 'your own address'

Development Guidelines

Git Commit Message Format

Adopt community commit format best practices:

# Before
git commit

# Now
npm run commit

This constraint relies on tools commitizen and commitlint provided by the community.

Related

If you want to develop a web application, maybe you can take a look:

create-web-app

Or, other similar things:

awesome-template

License

MIT.