https://github.com/sindresorhus/node-module-boilerplate
Boilerplate to kickstart creating a Node.js module
https://github.com/sindresorhus/node-module-boilerplate
node-boilerplate node-module nodejs npm-package template-repository
Last synced: 6 months ago
JSON representation
Boilerplate to kickstart creating a Node.js module
- Host: GitHub
- URL: https://github.com/sindresorhus/node-module-boilerplate
- Owner: sindresorhus
- License: mit
- Created: 2015-03-14T05:47:45.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2024-08-24T11:39:49.000Z (about 1 year ago)
- Last Synced: 2025-05-07T08:45:05.075Z (6 months ago)
- Topics: node-boilerplate, node-module, nodejs, npm-package, template-repository
- Language: JavaScript
- Homepage:
- Size: 36.1 KB
- Stars: 738
- Watchers: 14
- Forks: 76
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
- awesome-projects-boilerplates - Node Module boilerplate
- awesome-nodejs - node-module-boilerplate - Boilerplate to kickstart creating a node module. (Resources / Miscellaneous)
- awesome-nodejs - node-module-boilerplate - Boilerplate to kickstart creating a node module - ★ 424 (Miscellaneous)
- awesome-nodejs-cn - node-module-boilerplate - **star:737** 开始创建节点模块的样板文件 (资源 / 杂项)
- fucking-awesome-nodejs - node-module-boilerplate - Boilerplate to kickstart creating a node module. (Resources / Miscellaneous)
README
# node-module-boilerplate
> Boilerplate to kickstart creating a Node.js module
This is what I use for [my own modules](https://www.npmjs.com/~sindresorhus).
Also check out [`node-cli-boilerplate`](https://github.com/sindresorhus/node-cli-boilerplate).
## Getting started
**Click the "Use this template" button.**
Alternatively, create a new directory and then run:
```sh
curl -fsSL https://github.com/sindresorhus/node-module-boilerplate/archive/main.tar.gz | tar -xz --strip-components=1
```
---
**Remove everything from here and above**
---
# unicorn-fun
> My awesome module
## Install
```sh
npm install unicorn-fun
```
## Usage
```js
import unicornFun from 'unicorn-fun';
unicornFun('unicorns');
//=> 'unicorns & rainbows'
```
## API
### unicornFun(input, options?)
#### input
Type: `string`
Lorem ipsum.
#### options
Type: `object`
##### postfix
Type: `string`\
Default: `'rainbows'`
Lorem ipsum.