|
1 | | -# create-cli-application |
2 | | -A bootstrapper for creating a cli application with Node. |
| 1 | +<p align="center"> |
| 2 | + <a href="https://github.com/alexlee-dev/create-cli-application" rel="noopener"> |
| 3 | + <img width=256px height=256px src="https://res.cloudinary.com/alexlee-dev/image/upload/v1590513975/create-cli-application/proud.svg" alt="Logo"></a> |
| 4 | +</p> |
| 5 | + |
| 6 | +<h3 align="center">create-cli-application</h3> |
| 7 | + |
| 8 | +<div align="center"> |
| 9 | + |
| 10 | +[](https://www.npmjs.com/package/create-cli-application) |
| 11 | +[](https://github.com/alexlee-dev/create-cli-application/issues) |
| 12 | +[](https://github.com/alexlee-dev/create-cli-application) |
| 13 | +[](/LICENSE) |
| 14 | + |
| 15 | +</div> |
| 16 | + |
| 17 | +--- |
| 18 | + |
| 19 | +<p align="center">A bootstrapper for creating a cli application with Node. |
| 20 | + <br> |
| 21 | +</p> |
| 22 | + |
| 23 | +## 📝 Table of Contents |
| 24 | + |
| 25 | +- [About](#about) |
| 26 | +- [Getting Started](#getting_started) |
| 27 | +- [Deployment](#deployment) |
| 28 | +- [Usage](#usage) |
| 29 | +- [Built Using](#built_using) |
| 30 | +- [TODO](../TODO.md) |
| 31 | +- [Contributing](../CONTRIBUTING.md) |
| 32 | +- [Authors](#authors) |
| 33 | +- [Acknowledgments](#acknowledgement) |
| 34 | + |
| 35 | +## 🧐 About <a name = "about"></a> |
| 36 | + |
| 37 | +I generally use a template when developing CLI applications for myself. I want to share that same template with you, in an easy to use bootstrapper that mirrors the simplicity of starting a new application with [create-react-app](https://github.com/facebook/create-react-app). Thus, **create-cli-application** was born. |
| 38 | + |
| 39 | +## 🏁 Getting Started <a name = "getting_started"></a> |
| 40 | + |
| 41 | +### Prerequisites |
| 42 | + |
| 43 | +- Node |
| 44 | +- NPM |
| 45 | + |
| 46 | +### Installing |
| 47 | + |
| 48 | +`npm install -g create-cli-application` |
| 49 | + |
| 50 | +## 🎈 Usage <a name="usage"></a> |
| 51 | + |
| 52 | +`create-cli-application cool-app-name` |
| 53 | + |
| 54 | +## ⛏️ Built Using <a name = "built_using"></a> |
| 55 | + |
| 56 | +- [@sentry/node](https://sentry.io/welcome/) - Sentry is cross-platform application monitoring, with a focus on error reporting. |
| 57 | +- [boxen](https://github.com/sindresorhus/boxen) - Create boxes in the terminal. |
| 58 | +- [chalk](https://github.com/chalk/chalk) - Terminal string styling done right. |
| 59 | +- [clear](https://github.com/bahamas10/node-clear) - Clear the terminal screen if possible. |
| 60 | +- [configstore](https://github.com/yeoman/configstore) - Easily load and persist config without having to think about where and how. |
| 61 | +- [fs-extra](https://github.com/jprichardson/node-fs-extra) - Node.js: extra methods for the fs object like copy(), remove(), mkdirs(). |
| 62 | +- [inquirer](https://github.com/SBoudrias/Inquirer.js) - A collection of common interactive command line user interfaces. |
| 63 | +- [ora](https://github.com/sindresorhus/ora) - Elegant terminal spinner. |
| 64 | +- [pickitt](https://pickitt.netlify.com/) - When you need a computer to just pick it, reach for Pickitt! |
| 65 | +- [TypeScript](https://www.typescriptlang.org/) - A typed superset of JavaScript that compiles to plain JavaScript. |
| 66 | + |
| 67 | +## ✍️ Authors <a name = "authors"></a> |
| 68 | + |
| 69 | +- [Alex Lee](https://github.com/alexlee-dev) - Application Developer |
| 70 | + |
| 71 | +## 🎉 Acknowledgements <a name = "acknowledgement"></a> |
| 72 | + |
| 73 | +- Some inspiration from the developers behind [create-react-app](https://github.com/facebook/create-react-app). |
0 commit comments