Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/npm-officialk/npm-boilerplate

An all includive boilerplate to help you get quickly setup to create new NPM packages with good standards and tools used by industry.
https://github.com/npm-officialk/npm-boilerplate

boilerplate commitizen commitlint eslint github-actions husky jest jsdoc lint-staged npm-package prettier semantic-release snyk typescript yarn

Last synced: 5 days ago
JSON representation

An all includive boilerplate to help you get quickly setup to create new NPM packages with good standards and tools used by industry.

Host: GitHub
URL: https://github.com/npm-officialk/npm-boilerplate
Owner: npm-officialk
License: mit
Created: 2023-01-09T05:21:54.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2023-02-21T19:41:34.000Z (almost 2 years ago)
Last Synced: 2024-05-01T19:29:23.262Z (9 months ago)
Topics: boilerplate, commitizen, commitlint, eslint, github-actions, husky, jest, jsdoc, lint-staged, npm-package, prettier, semantic-release, snyk, typescript, yarn
Language: JavaScript
Homepage:
Size: 206 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        # check the `TODO.md` to setup the repo and project easily 😊

# `__PACKAGE_NAME__`

---

`__DESCRIPTION__`

---

[![Documentation site](https://img.shields.io/static/v1?style=for-the-badge&label=%20&message=documentation&color=blue&logo=readthedocs&logoColor=white)](__HOMEPAGE__)

**NPM**

[![NPM version](https://img.shields.io/npm/v/__PACKAGE_NAME__?style=for-the-badge)](https://npmjs.org/package/__PACKAGE_NAME__)

![NPM size](https://img.shields.io/bundlephobia/min/__PACKAGE_NAME__?style=for-the-badge)

![NPM vunerabilities](https://img.shields.io/snyk/vulnerabilities/npm/__PACKAGE_NAME__?style=for-the-badge)

**GitHub**

[![GitHub License](https://img.shields.io/github/license/__GITHUB_USER__/__REPO__?style=for-the-badge)](https://github.com/__GITHUB_USER__/__REPO__/README.md)

[![GitHub issues](https://img.shields.io/github/issues/__GITHUB_USER__/__REPO__?style=for-the-badge)](https://github.com/__GITHUB_USER__/__REPO__/issues/)

[![GitHub PRs](https://img.shields.io/github/issues-pr/__GITHUB_USER__/__REPO__?style=for-the-badge)](https://github.com/__GITHUB_USER__/__REPO__/pulls/)

[![GitHub Milestones](https://img.shields.io/github/milestones/all/__GITHUB_USER__/__REPO__?style=for-the-badge)](https://github.com/__GITHUB_USER__/__REPO__/milestones/)

![GitHub Sponsors](https://img.shields.io/github/sponsors/__GITHUB_USER__?style=for-the-badge)

## Installation

```yarn

yarn add __PACKAGE_NAME__

```

```npm

npm install __PACKAGE_NAME__

```

## Usage

[Refer to the Documentation](__HOMEPAGE__)

## For the devs

[Refer to the Developer Release Documentation](https://__GITHUB_USER__.github.io/__REPO__)

use the `__RUNNER__ link` in the package's folder

and `__RUNNER__ link "__PACKAGE_NAME__"` in the folder you want to test the package in

this will install the package as a symbolic link in the test folder

now you can now use the package as if it was installed.

## Contributing

Pull requests are welcome. For major changes, please open an issue first

to discuss what you would like to change.

Some files to refer

-   [CONTRIBUTING](./.github/CONTRIBUTING.md)

-   [CODE_OF_CONDUCT](./.github/CODE_OF_CONDUCT.md)

Please make sure to update tests as appropriate.

## License

[LICENSE](./LICENSE)