Skip to content

ptkdev-boilerplate/node-cli-boilerplate

Repository files navigation

๐Ÿช“ node-cli-boilerplate

v1.0.20210331 License: MIT Language: TypeScript ECMAScript: 2019 Discord Server

Create node cli with this friendly boilerplate. Use this respository as template for your new node command line interface project

๐ŸŽ 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!

Donate Paypal Donate Ko-Fi Donate Github Sponsors Donate Patreon Donate Bitcoin Donate Ethereum

๐Ÿ“Ž Menu

๐Ÿ’ก Features

  • [โœ”๏ธ] 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

๐Ÿš€ Usage

  1. In your node project run: npm install @ptkdev/node-cli-boilerplate -g
  2. Usage, run anywhere: node-cli-boilerplate

You can use npx, example: npx @ptkdev/node-cli-boilerplate

๐Ÿ”จ Developer Mode

  1. Clone this repository or download nightly, beta or stable.
  2. Run npm install
  3. Run npm run build && npm run link (unix require sudo)
  4. Run node-cli-boilerplate anywhere for execute command line tool

or run npm run dev for watch mode.

๐Ÿ“š 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, name and web site url.

๐Ÿ‘จโ€๐Ÿ’ป Contributing

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!

๐Ÿฆ„ 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