https://github.com/ptkdev-boilerplate/node-module-boilerplate
🧰 Create your npm library with this user friendly boilerplate. Use this respository as template for your new node library/module
https://github.com/ptkdev-boilerplate/node-module-boilerplate
github-template module module-generator modules node node-boilerplate node-library node-module nodejs typescript
Last synced: 3 days ago
JSON representation
🧰 Create your npm library with this user friendly boilerplate. Use this respository as template for your new node library/module
- Host: GitHub
- URL: https://github.com/ptkdev-boilerplate/node-module-boilerplate
- Owner: ptkdev-boilerplate
- License: other
- Created: 2021-03-18T22:46:52.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-15T23:32:51.000Z (about 2 years ago)
- Last Synced: 2025-05-10T10:48:20.759Z (9 days ago)
- Topics: github-template, module, module-generator, modules, node, node-boilerplate, node-library, node-module, nodejs, typescript
- Language: TypeScript
- Homepage: https://npmjs.com/package/@ptkdev/node-module-boilerplate
- Size: 6.61 MB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# 🧰 node-module-boilerplate
[](https://github.com/ptkdev-boilerplate/node-module-boilerplate/blob/main/CHANGELOG.md) [](https://www.npmjs.com/package/@ptkdev/node-module-boilerplate) [](https://github.com/ptkdev-boilerplate/node-module-boilerplate/blob/main/LICENSE.md) [](https://www.typescriptlang.org/) [](https://github.com/tc39/ecma262) [](https://discord.ptkdev.io)
Create your npm library with this user friendly boilerplate. Use this respository as template for your new node library/module
This is a [github template](https://github.blog/2019-06-06-generate-new-repositories-with-repository-templates/), you can fork it or [use as template](https://github.com/ptkdev-boilerplate/node-module-boilerplate/generate) for start new project with this repository as hello-world. I hate start new project with empty template, often i missing correct configuration, readme instruction or i need of samples of code. Use this repository as template solve this problem.
## 🎁 Support: Donate
> This project is **free**, **open source** and I try to provide excellent **free support**. Why donate? I work on this project several hours in my spare time and try to keep it up to date and working. **THANK YOU!**
[](https://www.paypal.me/ptkdev) [](https://ko-fi.com/ptkdev) [](https://github.com/sponsors/ptkdev) [](https://www.patreon.com/join/ptkdev) [](https://ptk.dev/img/icons/menu/bitcoin_wallet.png) [](https://ptk.dev/img/icons/menu/ethereum_wallet.png)
## 📎 Menu
- 💡 [Features](#-features)
- 🚀 [How to use](#-usage)
- 📚 [Documentation](#-documentation)
- 🔨 [Developer Mode](#-developer-mode)
- - 🏁 [Run Project](#-run-project)
- - 💾 [Setup Project](#-setup-project)
- 👨💻 [Contributing](#-contributing)
- 🐛 [Known Bugs](https://github.com/ptkdev-boilerplate/node-module-boilerplate/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
- 🍻 Community:
- 
Telegram ([🇬🇧 English](http://t.me/ptkdev_support) | [🇮🇹 Italian](http://t.me/ptkdev_support_italian))
- 
[Discord](http://discord.ptkdev.io) ([🇬🇧 English](https://discord.gg/jqUSGPKdmA) | [🇮🇹 Italian](https://discord.gg/SJFcbvG6RU) | [🇵🇱 Polish](https://discord.gg/25vg4VFhb7))
- 
[Twitter](http://twitter.com/ptkdevio)
## 💡 Features
- [✔️] Easy to use
- [✔️] MIT License
- [✔️] Make node module (library) Package for npm
- [✔️] Friendly boilerplate + Github templates
- [✔️] Typescript + TSPaths preconfigured
- [✔️] Userfriendly folders tree
- [✔️] Prettiers and ESLint preconfigured
- [✔️] all-contributors-cli and all-shields-cli preconfigured
- [✔️] JEST Test preconfigured
- [✔️] Full async code
- [✔️] Github and Vscode dotfiles preconfigured
- [✔️] Translations: 🇬🇧 🇮🇹 🇵🇱 (Help me ❤️)
## 🚀 Usage
1. In your node project run: `npm install @ptkdev/node-module-boilerplate@latest --save`
2. Usage (async):
```javascript
import m from "@ptkdev/node-module-boilerplate";
(async () => {
const { app } = await m({ text: "hello-world" });
console.log(app());
})();
```
## 🔨 Developer Mode
#### 🏁 Run Project
1. Clone this repository or download [nightly](https://github.com/ptkdev-boilerplate/node-module-boilerplate/archive/nightly.zip), [beta](https://github.com/ptkdev-boilerplate/node-module-boilerplate/archive/beta.zip) or [stable](https://github.com/ptkdev-boilerplate/node-module-boilerplate/archive/main.zip).
2. Run `npm install`
3. Run `npm run dev`
#### 💾 Setup Project
If you want replace all strings (example: package name, author, urls, etc...) in markdown file, source files and others files of this project you need edit `setup.json` with correct values and run `npm run setup`.
## 📚 Documentation
Run `npm run docs`
## 👑 Backers and Sponsors
Thanks to all our backers! 🙏 Donate 3$ or more on [paypal](https://www.paypal.me/ptkdev), [ko-fi](https://ko-fi.com/ptkdev), [github](https://github.com/sponsors/ptkdev) or [patreon](https://www.patreon.com/join/ptkdev) and send me [email](mailto:[email protected]) with your avatar and url.
[](https://api.ptkdev.io/backers/sponsor1.html) [](https://api.ptkdev.io/backers/sponsor2.html) [](https://api.ptkdev.io/backers/sponsor-kofi1.html) [](https://api.ptkdev.io/backers/sponsor-kofi2.html) [](https://api.ptkdev.io/backers/sponsor-kofi3.html) [](https://api.ptkdev.io/backers/sponsor3.html) [](https://api.ptkdev.io/backers/sponsor4.html) [](https://api.ptkdev.io/backers/sponsor5.html) [](https://api.ptkdev.io/backers/sponsor6.html) [](https://api.ptkdev.io/backers/sponsor7.html) [](https://api.ptkdev.io/backers/sponsor8.html) [](https://api.ptkdev.io/backers/sponsor9.html) [](https://api.ptkdev.io/backers/sponsor10.html) [](https://api.ptkdev.io/backers/sponsor11.html) [](https://api.ptkdev.io/backers/sponsor12.html) [](https://api.ptkdev.io/backers/sponsor13.html) [](https://api.ptkdev.io/backers/sponsor14.html) [](https://api.ptkdev.io/backers/sponsor15.html) [](https://api.ptkdev.io/backers/backer1.html) [](https://api.ptkdev.io/backers/backer2.html) [](https://api.ptkdev.io/backers/backer3.html) [](https://api.ptkdev.io/backers/backer4.html) [](https://api.ptkdev.io/backers/backer5.html) [](https://api.ptkdev.io/backers/backer6.html) [](https://api.ptkdev.io/backers/backer7.html) [](https://api.ptkdev.io/backers/backer8.html) [](https://api.ptkdev.io/backers/backer9.html) [](https://api.ptkdev.io/backers/backer10.html) [](https://api.ptkdev.io/backers/backer11.html) [](https://api.ptkdev.io/backers/backer12.html) [](https://api.ptkdev.io/backers/backer13.html) [](https://api.ptkdev.io/backers/backer14.html) [](https://api.ptkdev.io/backers/backer15.html) [](https://api.ptkdev.io/backers/backer16.html) [](https://api.ptkdev.io/backers/backer17.html) [](https://api.ptkdev.io/backers/backer18.html) [](https://api.ptkdev.io/backers/backer19.html) [](https://api.ptkdev.io/backers/backer20.html) [](https://api.ptkdev.io/backers/backer21.html) [](https://api.ptkdev.io/backers/backer22.html) [](https://api.ptkdev.io/backers/backer23.html) [](https://api.ptkdev.io/backers/backer24.html) [](https://api.ptkdev.io/backers/backer25.html) [](https://api.ptkdev.io/backers/backer26.html) [](https://api.ptkdev.io/backers/backer27.html) [](https://api.ptkdev.io/backers/backer28.html) [](https://api.ptkdev.io/backers/backer29.html)
## 👨💻 Contributing
I ❤️ contributions! I will happily accept your pull request! (**IMPORTANT**: Only to nightly branch!) Translations, grammatical corrections (GrammarNazi you are welcome! Yes my English is bad, sorry), etc... Do not be afraid, if the code is not perfect we will work together 👯 and remember to insert your name in `.all-contributorsrc` and `package.json` file.
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
> 💰 In the future, if the donations allow it, I would like to share some of the success with those who helped me the most. For me open source is share of code, share development knowledges and share donations!
## 🦄 Other Projects
[](https://ptk.dev/)
[](https://github.com/ptkdev/ptkdev-logger) [](https://github.com/ptkdev/all-shields-cli) [](https://github.com/ptkdev/chrome-extension-aspectratio219) [](https://availableon.badge.ptkdev.io/) [](https://github.com/ptkdev/json-token-replace) [](https://github.com/ptkdev/eslint-plugin-snakecasejs)
[](https://github.com/ptkdev-components) [](https://github.com/ptkdev/aboutmeinfo-telegram-bot) [](https://github.com/ptkdev/quizquickanswer-telegram-game-bot) [](https://t.me/gamebookchatbot) [](https://github.com/ptkdev/vscode-theme-dark-blood) [](https://github.com/sourcesense/joyce)
[](https://github.com/ptkdev-boilerplate?q=svelte) [](https://github.com/ptkdev-boilerplate?q=webcomponent) [](https://github.com/ptkdev-boilerplate?q=bot) [](https://github.com/ptkdev-boilerplate?q=node) [](https://meingifs.pics/) [](https://github.com/ptkdev/ptkdev-stickers#-installation)
## 💫 License
- Code and Contributions have **MIT License**
- Images and logos have **CC BY-NC 4.0 License**
- Documentations and Translations have **CC BY 4.0 License**
###### Copyleft (c) 2021 [Patryk Rzucidło](https://ptk.dev) ([@PTKDev](https://twitter.com/ptkdev)) <[[email protected]](mailto:[email protected])>
