https://github.com/professormanhattan/template-npm-package

A boilerplate for a generic NPM package
https://github.com/professormanhattan/template-npm-package

library mblabs megabytelabs professormanhattan washingtondc

Last synced: about 1 month ago
JSON representation

A boilerplate for a generic NPM package

Host: GitHub
URL: https://github.com/professormanhattan/template-npm-package
Owner: ProfessorManhattan
License: other
Created: 2022-04-23T06:15:28.000Z (about 3 years ago)
Default Branch: master
Last Pushed: 2023-03-23T13:03:45.000Z (about 2 years ago)
Last Synced: 2025-01-30T20:42:30.739Z (3 months ago)
Topics: library, mblabs, megabytelabs, professormanhattan, washingtondc
Language: Shell
Homepage: https://megabyte.space
Size: 2.47 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Codeowners: docs/CODEOWNERS

Awesome Lists containing this project

README

Boilerplate for Generic NPM Package

An NPM library maintained by Megabyte Labs

A boilerplate for a generic NPM package

## Table of Contents

- [Overview](#overview)
- [Requirements](#requirements)
- [Developer Requirements](#developer-requirements)
- [Generic NPM Package Boilerplate Specifics](#generic-npm-package-boilerplate-specifics)
- [Contributing](#contributing)
- [Affiliates](#affiliates)
- [License](#license)

## Overview

This repository contains the standard configs we include in all of our projects along with some configs / settings unique to NPM packages. This template is meant to be the starting point for TypeScript-based NPM packages.

## Requirements

If you are simply including this library in your project, all you need is a recent version of Node.js. **[Node.js >14.18.0](repository.project.node)** is sometimes required and is the only version range we actively support. Albeit, it is highly probable that lower versions will work as well depending on the requirements that this project imports.

### Developer Requirements

The following versions of Node.js and Python are required for development:

- **[Node.js >14.18.0](repository.project.node)**
- **[Python >3.10.0](repository.project.python)**

Other versions may work, but only the above versions are supported. Most development dependencies are installed automatically by our `Taskfile.yml` set-up (even Node.js and Python). Run `bash start.sh` to install **[Bodega](https://github.com/ProfessorManhattan/Bodega)** (an improved fork of [go-task](https://github.com/go-task/task)) and run the initialization sequence. The taskfiles will automatically install dependencies as they are needed, based on what development tasks you are running. For more information, check out the [CONTRIBUTING.md](https://github.com/megabyte-labs/template-npm-package/blob/main/docs/CONTRIBUTING.md) or simply run:

```shell
npm run help
```

`npm run help` will ensure Bodega is installed and then open an interactive dialog where you can explore and learn about various developer commands.

## Generic NPM Package Boilerplate Specifics

This repository is provided as a starting point for NPM packages that would not benefit from our other NPM/Node.js project starting templates (i.e. [Node.js app template](https://github.com/megabyte-labs/template-nodejs-app) and [NPM CLI template](https://github.com/megabyte-labs/template-npm-cli)). It packages together all of the standard [Megabyte Labs](https://megabyte.space) repository configurations and scripts along with some NPM package specific starting files.

## Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/megabyte-labs/template-npm-package/issues). If you would like to contribute, please take a look at the [contributing guide](https://github.com/megabyte-labs/template-npm-package/blob/master/docs/CONTRIBUTING.md).

Sponsorship

Dear Awesome Person,

I create open source projects out of love. Although I have a job, shelter, and as much fast food as I can handle, it would still be pretty cool to be appreciated by the community for something I have spent a lot of time and money on. Please consider sponsoring me! Who knows? Maybe I will be able to quit my job and publish open source full time.

Sincerely,

**_Brian Zalewski_**