https://github.com/wang1212/create-lib-starter
:coffee: (Template) Startup configuration for building a JavaScript/Node.js library. | （模版）构建一个 JavaScript/Node.js 库的启动配置。
https://github.com/wang1212/create-lib-starter
babel eslint nodejs prettier rollup rollup-config rollup-example typescript web
Last synced: 4 months ago
JSON representation
:coffee: (Template) Startup configuration for building a JavaScript/Node.js library. | （模版）构建一个 JavaScript/Node.js 库的启动配置。
- Host: GitHub
- URL: https://github.com/wang1212/create-lib-starter
- Owner: wang1212
- License: mit
- Created: 2020-05-20T01:06:16.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-04-10T10:00:59.000Z (about 2 years ago)
- Last Synced: 2024-04-11T00:17:42.063Z (about 2 years ago)
- Topics: babel, eslint, nodejs, prettier, rollup, rollup-config, rollup-example, typescript, web
- Language: JavaScript
- Homepage:
- Size: 509 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Create JavaScript Lib Starter
[](http://commitizen.github.io/cz-cli/)
[](https://www.codacy.com/gh/wang1212/create-lib-starter/dashboard?utm_source=github.com&utm_medium=referral&utm_content=wang1212/create-lib-starter&utm_campaign=Badge_Grade)
English | [简体中文](./README.zh-CN.md)
This is a startup development configuration template used to build the **JavaScript/Node.js** library.
## Templates
The following templates are provided here:
- [JavaScript](./templates/javascript/)
- [TypeScript](./templates/typescript/)
- [CLI(JavaScript)](./templates/cli/)
## Usage
1. There are two ways to use this template:
- Open [GitHub Repository Website](https://github.com/wang1212/create-lib-starter), then Click **Use this template** Button.
- Another way, clone to local
```bash
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](https://choosealicense.com/).
- Modify `package.json` information, such as `name`, `description`, etc.
- Set the remote address of the github repository to your own:
```bash
git remote set-url origin 'your own address'
```
## Development Guidelines
### Git Commit Message Format
Adopt [community commit format best practices](https://www.conventionalcommits.org/):
```bash
# Before
git commit
# Now
npm run commit
```
_This constraint relies on tools [commitizen](http://commitizen.github.io/cz-cli/) and [commitlint](https://commitlint.js.org/) provided by the community._
## Related
If you want to develop a web application, maybe you can take a look:
> [create-web-app](https://github.com/wang1212/create-web-app)
Or, other similar things:
> [awesome-template](https://github.com/wang1212/awesome-template)
## License
[MIT](./LICENSE).