Skip to content

Commit 8168fd6

Browse files
endormiendormi
authored
CLI and copy script
2 parents aeefc76 + 9c1d2ba commit 8168fd6

File tree

5 files changed

+167
-127
lines changed

5 files changed

+167
-127
lines changed

‎README.md‎

Lines changed: 66 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,46 @@
1-
```
2-
_ _ _ _ ____ _ ____ _ ___
3-
/ \ __| |__ __ __ _ _ __ __| | ___ __| | | _ \ ___ __ _ ___ | |_ / ___|| | |_ _|
4-
/ _ \ / _` |\ \ / // _` || '_ \ / _` | / _ \ / _` | | |_) |/ _ \ / _` | / __|| __| | | | | | |
5-
/ ___ \| (_| | \ V /| (_| || | | || (_| || __/| (_| | | _ <| __/| (_| || (__ | |_ | |___ | |___ | |
6-
/_/ \_\\__,_| \_/ \__,_||_| |_| \__,_| \___| \__,_| |_| \_\\___| \__,_| \___| \__| \____||_____||___|
1+
<div class="highlight">
2+
<pre tabindex="0" class="chroma">
3+
<code class="language-fallback" data-lang="fallback">
4+
_ _ ____ _ ____ _ ___
5+
/ \ __| |__ __ | _ \ ___ __ _ ___ | |_ / ___|| | |_ _|
6+
/ _ \ / _` |\ \ / / | |_) |/ _ \ / _` | / __|| __| | | | | | |
7+
/ ___ \| (_| | \ V /_ | _ <| __/| (_| || (__ | |_ | |___ | |___ | |
8+
/_/ \_\\__,_| \_/(_) |_| \_\\___| \__,_| \___| \__| \____||_____||___|
9+
10+
</code>
11+
</pre>
12+
</div>
13+
14+
<div>
15+
<h2>
16+
<span>
17+
Table of Contents
18+
</span>
19+
</h2>
20+
</div>
21+
22+
<div>
23+
<ul>
24+
<li><a href="#About">About</a></li>
25+
<li><a href="#projects-purpose">Project's purpose</a></li>
26+
<li><a href="#credits">Credits</a></li>
27+
<li><a href="#run-the-cli">Run the CLI</a></li>
28+
<li><a href="#installing-the-cli-globally">Installing the CLI globally</a></li>
29+
<li><a href="#packages">Packages</a></li>
30+
<li><a href="#running-tests">Running tests</a></li>
31+
<li><a href="https://github.com/devisle/advanced-react-cli/blob/master/CONTRIBUTING.md">Contributing</a></li>
32+
<li><a href="https://github.com/devisle/advanced-react-cli/blob/master/CHECKLIST.md">Development Checklist</a></li>
33+
<li><a href="#what-does-this-do">What does this do?</a></li>
34+
<li><a href="#faqs">FAQs</a></li>
35+
<li><a href="#dev-isle-community">Dev Isle community</a></li>
36+
<li><a href="https://github.com/devisle/advanced-react-cli/blob/master/LICENSE">License</a></li>
37+
</ul>
38+
</div>
739

8-
```
40+
## About
941

1042
[![version](https://img.shields.io/npm/v/advanced-react-cli.svg?color=blue)](https://www.npmjs.com/package/advanced-react-cli) [![downloads](https://img.shields.io/npm/dw/advanced-react-cli.svg)](https://www.npmjs.com/package/advanced-react-cli) ![Test](https://github.com/devisle/advanced-react-cli/workflows/Test/badge.svg) ![CodeQL](https://github.com/devisle/advanced-react-cli/actions/workflows/codeql.yml/badge.svg)
1143

12-
## Table of Contents
13-
14-
- [About](#about)
15-
- [Project's purpose](#projects-purpose)
16-
- [Credits](#credits)
17-
- [Run the CLI](#run-the-cli)
18-
- [Installing the CLI globally](#installing-the-cli-globally)
19-
- [Packages](#packages)
20-
- [Running tests](#running-tests)
21-
- [Contributing](CONTRIBUTING.md)
22-
- [Development Checklist](CHECKLIST.md)
23-
- [What does this do?](#what-does-this-do)
24-
- [FAQs](#faqs)
25-
- [Dev Isle community](#dev-isle-community)
26-
- [License](https://github.com/devisle/advanced-react-cli/blob/master/LICENSE)
27-
28-
## About
29-
3044
This is an **NPM package** which aims to provide a better way to install a React-starter application and third-party packages for your application through an intuitive CLI.
3145

3246
## Project's Purpose
@@ -35,18 +49,7 @@ We at Dev Isle, felt that the community has been longing for a good, functional
3549

3650
**Note**: We do not discourage or refrain the community from using terminal commands instructions. In fact, we highly recommend our users to read and understand the docs so that you will know what to expect. This CLI is merely an alternative!
3751

38-
## Credits
39-
40-
This CLI uses some of the best repos' terminal commands under the hood, to execute it's functionality. We would like to credit the following GitHub repos by making this CLI possible:
41-
42-
- [Brandon Nozaki Miller - Node-CMD](https://github.com/RIAEvangelist/node-cmd)
43-
- [Simon Boudrias - Inquirer JS](https://github.com/SBoudrias/Inquirer.js/)
44-
- [Nathan Peck - CLUI](https://www.npmjs.com/package/clui)
45-
- [Dave Eddy - Clear](https://github.com/bahamas10/node-clear)
46-
- [Patorjk - Figlet](https://github.com/patorjk/figlet.js)
47-
- [Chalk](https://www.npmjs.com/package/chalk)
48-
49-
**Be sure to check the above repos out if you're facing any issues! We are of course, always open to improvements.**
52+
**Be sure to check the repos in [credits](#credits) if you're facing any issues! We are of course, always open to improvements.**
5053

5154
## Run the CLI
5255

@@ -87,6 +90,21 @@ The CLI currently has these packages available for installation:
8790
- [@types/react-router](https://www.npmjs.com/package/@types/react-router) & [@types/react-router-dom](https://www.npmjs.com/package/@types/react-router-dom)
8891
- [@types/jest](https://www.npmjs.com/package/@types/jest)
8992

93+
## What does this do?
94+
95+
We are continuously working on improving the CLI. But, as of this current stable version, we have enabled a few options such as:
96+
97+
- Yarn/NPM option for installation packages
98+
- Installing React using `create-react-app`, with optional packages React-Router and Redux as a single bundle.
99+
- React Component generator lets you make a class/function component with optional package imports such as prop-types, react-router and redux!
100+
- Installing Individual packages such as Node-Sass, Styled-Components, React-Router, Prop-Types, and State Management.
101+
- Redux, Unstated, Unstated-Next and Redux-Thunk have been added in the State Management.
102+
- Installing Redux automatically generates a store folder containing boilerplate Redux code with instructions to get you started!
103+
- Installing Prop-Types automatically generates a file containing a sample code to get started!
104+
- Node-Sass and Styled-Components feature under StyledPackages section of the CLI
105+
- Installing packages used for accessibility such as React-A11y and React-Axe.
106+
- TypeScript and `@types` definitions for Node, React, React-Router, React-Redux and Jest
107+
90108
## Running tests
91109

92110
Test:
@@ -101,27 +119,23 @@ Test coverage:
101119
npm run test:coverage or yarn test:coverage
102120
```
103121

104-
## What does this do?
122+
## Credits
105123

106-
We are continuously working on improving the CLI. But, as of this current stable version, we have enabled a few options such as:
124+
This CLI uses some of the best repos' terminal commands under the hood, to execute it's functionality. We would like to credit the following GitHub repos by making this CLI possible:
107125

108-
- Yarn/NPM option for installation packages
109-
- Installing React using `create-react-app`, with optional packages React-Router and Redux as a single bundle.
110-
- React Component generator lets you make a class/function component with optional package imports such as prop-types, react-router and redux!
111-
- Installing Individual packages such as Node-Sass, Styled-Components, React-Router, Prop-Types, and State Management.
112-
- Redux, Unstated, Unstated-Next and Redux-Thunk have been added in the State Management.
113-
- Installing Redux automatically generates a store folder containing boilerplate Redux code with instructions to get you started!
114-
- Installing Prop-Types automatically generates a file containing a sample code to get started!
115-
- Node-Sass and Styled-Components feature under StyledPackages section of the CLI
116-
- Installing packages used for accessibility such as React-A11y and React-Axe.
117-
- TypeScript and `@types` definitions for Node, React, React-Router, React-Redux and Jest
126+
- [Brandon Nozaki Miller - Node-CMD](https://github.com/RIAEvangelist/node-cmd)
127+
- [Simon Boudrias - Inquirer JS](https://github.com/SBoudrias/Inquirer.js/)
128+
- [Nathan Peck - CLUI](https://www.npmjs.com/package/clui)
129+
- [Dave Eddy - Clear](https://github.com/bahamas10/node-clear)
130+
- [Patorjk - Figlet](https://github.com/patorjk/figlet.js)
131+
- [Chalk](https://www.npmjs.com/package/chalk)
118132

119-
# FAQs
133+
## FAQs
120134

121135
1. How can I test this out?
122136

123137
- If you'd like to try it out , Run the following command `npx advanced-react-cli` in your terminal.
124-
- We are still continuing to work on our [Development Checklist](CHECKLIST.md).
138+
- We are still continuing to work on our [Development Checklist](https://github.com/devisle/advanced-react-cli/blob/master/CHECKLIST.md).
125139

126140
- Ensure you have git version control, and package manager - either npm (node package manager) or Yarn Installed. You may check if your system has them installed by running the following commands `git --version` and depending on your package manager of choice, run `npm --version` or `yarn --version`. If you don't have it installed, please visit:
127141

@@ -152,7 +166,7 @@ We are continuously working on improving the CLI. But, as of this current stable
152166

153167
- The documentation site is built using [docsify](https://docsify.js.org/#/).
154168
- Install `docsify` if you haven't done that already `npm i docsify-cli -g`.
155-
- Run the site `docsify serve docs`.
169+
- Run the site `npm run docs`.
156170

157171
## Dev Isle Community
158172

‎cli.js‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,7 @@
22

33
const [...args] = process.argv
44

5-
// console.log(`folder name ${args[2]}`);
6-
// console.log(`folder location ${args[3]}`);
7-
8-
// Current working directory
9-
const cwd = process.cwd()
10-
console.log(cwd)
11-
125
const inquirer = require('inquirer')
13-
146
const chalk = require('chalk')
157
const clear = require('clear')
168
const figlet = require('figlet')

0 commit comments

Comments
 (0)