Create node cli with this friendly boilerplate. Use this respository as template for your new node command line interface project
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!
- 💡 Features
- 🚀 How to use
- 🔨 Developer Mode
- 👨💻 Contributing
- 🐛 Known Bugs
- 🍻 Community:
- [✔️] Easy to use
- [✔️] MIT License
- [✔️] Make CLI 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
- [✔️] i18n translations
- [✔️] Github and Vscode dotfiles preconfigured
- In your node project run:
npm install @ptkdev/node-cli-boilerplate -g
- Usage, run anywhere:
node-cli-boilerplate
You can use npx, example: npx @ptkdev/node-cli-boilerplate
- Clone this repository or download nightly, beta or stable.
- Run
npm install
- Run
npm run build && npm run link
(unix requiresudo
) - Run
node-cli-boilerplate
anywhere for execute command line tool
or run npm run dev
for watch mode.
Run npm run docs
Thanks to all our backers! 🙏 Donate 3$ or more on paypal, ko-fi, github or patreon and send me email with your avatar, name and web site url.
I ❤️ contributions! I will happily accept your pull request! 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!
- 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