https://github.com/inverternetwork/npm
https://github.com/inverternetwork/npm
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/inverternetwork/npm
- Owner: InverterNetwork
- License: lgpl-3.0
- Created: 2023-12-12T10:10:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-05T12:36:06.000Z (4 months ago)
- Last Synced: 2025-01-29T14:22:11.176Z (4 months ago)
- Language: TypeScript
- Size: 278 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
[![npm latest package][npm-latest-image]][npm-url]
[![Build Status][ci-image]][ci-url]
[![License][license-image]][license-url]
[![npm downloads][npm-downloads-image]][npm-url]
[![Follow on Twitter][twitter-image]][twitter-url]
## Inverter / NPM package Template
Bun + Npm + Typescript + Standard Version + Flat Config Linting + Husky + Commit / Release Pipeline
## Summary
This package contains < a template for devoloping for npm packages > for [](https://github.com/).
Check out the [Changelog](./CHANGELOG.md) to see what changed in the last releases.
## Install
```bash
bun add
```
Install Bun ( bun is the default package manager for this project ( its optional ) ):
```bash
# Supported on macOS, Linux, and WSL
curl -fsSL https://bun.sh/install | bash
# Upgrade Bun every once in a while
bun upgrage
```
## Developing
Install Dependencies:
```bash
bun i
```
Watching TS Problems:
```bash
bun watch
```
## How to make a release
**For the Maintainer**: Add `NPM_TOKEN` to the GitHub Secrets.
1. PR with changes
2. Merge PR into main
3. Checkout main
4. `git pull`
5. `bun release: '' | alpha | beta` optionally add `-- --release-as minor | major | 0.0.1`
6. Make sure everything looks good (e.g. in CHANGELOG.md)
7. Lastly run `bun release:pub`
8. Done
## License
This package is licensed - see the [LICENSE](./LICENSE) file for details.
[ci-image]: https://badgen.net/github/checks///main?label=ci
[ci-url]: https://github.com///actions/workflows/ci.yaml
[npm-url]: https://npmjs.org/package/
[twitter-url]: https://twitter.com/
[twitter-image]: https://img.shields.io/twitter/follow/.svg?label=follow+
[license-image]: https://img.shields.io/badge/License-LGPL%20v3-blue
[license-url]: ./LICENSE
[npm-latest-image]: https://img.shields.io/npm/v//latest.svg
[npm-downloads-image]: https://img.shields.io/npm/dm/.svg