Skip to content

Commit 9794c77

Browse files
author
Alex Lee
authored
Merge pull request #1 from alexlee-dev/v0.1.0
📦 v0.1.0
2 parents 82ee7c2 + 6f28042 commit 9794c77

File tree

19 files changed

+1997
-5
lines changed

19 files changed

+1997
-5
lines changed

CHANGELOG.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [0.1.0] - 2020-05-26
9+
10+
### 🚀 First Happy Path Solution
11+
12+
### Added
13+
14+
- Initial logic of create-cli-application
15+
16+
### Changed
17+
18+
### Removed
19+
20+
### Fixed

README.md

Lines changed: 73 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,73 @@
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+
[![NPM](https://img.shields.io/npm/v/create-cli-application.svg)](https://www.npmjs.com/package/create-cli-application)
11+
[![GitHub Issues](https://img.shields.io/github/issues/alexlee-dev/create-cli-application)](https://github.com/alexlee-dev/create-cli-application/issues)
12+
[![Dependencies](https://img.shields.io/david/alexlee-dev/create-cli-application)](https://github.com/alexlee-dev/create-cli-application)
13+
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/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).

index.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#!/usr/bin/env node
2+
3+
const createCliApplication = require("./build/index").default;
4+
5+
createCliApplication();

0 commit comments

Comments
 (0)