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

🧰 node-module-boilerplate

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, you can fork it or use as template 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!

📎 Menu

• 💡 Features
• 🚀 How to use
• 📚 Documentation
• 🔨 Developer Mode
• • 🏁 Run Project
• • 💾 Setup Project
• 👨‍💻 Contributing
• 🐛 Known Bugs
• 🍻 Community:
  • Telegram (🇬🇧 English | 🇮🇹 Italian)
  • Discord (🇬🇧 English | 🇮🇹 Italian | 🇵🇱 Polish)
  • Twitter

💡 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):

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, beta or stable.
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, ko-fi, github or patreon and send me email with your avatar and url.

👨‍💻 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):

Patryk Rzucidło 💻 🌍 📖 🐛

💰 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

💫 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 (@PTKDev) <[e-mail]>