Table of Contents
- Project's purpose
- Run the CLI
- Installing the CLI globally
- Running tests
- Development Checklist
- What does this do?
- Dev Isle community
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.
We at Dev Isle, felt that the community has been longing for a good, functional and intuitive CLI rather than always writing on the terminal command line.
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!
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:
- Brandon Nozaki Miller - Node-CMD
- Simon Boudrias - Inquirer JS
- Nathan Peck - CLUI
- Dave Eddy - Clear
- Patorjk - Figlet
Be sure to check the above repos out if you're facing any issues! We are of course, always open to improvements.
Run the CLI
Just type in the following command in your terminal and run it! (Please check FAQ for more on testing and contributions)
Installing the CLI globally
npm i -g advanced-react-cli
yarn global add advanced-react-cli
To invoke the CLI (Both NPM & Yarn)
The CLI currently has these packages available for installation:
- React-Router & React-Router-Dom
- Redux & React-Redux
- @types/react & @types/react-dom
- @types/react-router & @types/react-router-dom
npm run test or yarn test
npm run test:coverage or yarn test:coverage
What does this do?
We are continuously working on improving the CLI. But, as of this current stable version, we have enabled a few options such as:
- Yarn/NPM option for installation packages
- Installing React using
create-react-app, with optional packages React-Router and Redux as a single bundle.
- React Component generator lets you make a class/function component with optional package imports such as prop-types, react-router and redux!
- Installing Individual packages such as Node-Sass, Styled-Components, React-Router, Prop-Types, and State Management.
- Redux, Unstated, Unstated-Next and Redux-Thunk have been added in the State Management.
- Installing Redux automatically generates a store folder containing boilerplate Redux code with instructions to get you started!
- Installing Prop-Types automatically generates a file containing a sample code to get started!
- Node-Sass and Styled-Components feature under StyledPackages section of the CLI
- Installing packages used for accesibility such as React-A11y and React-Axe.
- TypeScript and
@typesdefinitions for Node, React, React-Router, React-Redux and Jest
- How can I test this out?
If you'd like to try it out , Run the following command
npx advanced-react-cliin your terminal.
We are still continuing to work on our Development Checklist.
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 --versionand depending on your package manager of choice, run
yarn --version. If you don't have it installed, please visit:
Alternatively, if you would like to contribute and test it locally, you may fork the repo, and/or clone it to your local desktop. Once you've done that, open the terminal in that local folder and run the command
npm installfor NPM users or
yarn installfor Yarn users to install the required dependencies.
After that, you may open the folder in your editor of choice. Once again, in the terminal you may simply run
npm run react-clior
yarn run react-clito get it working. And voila!
- Can I report any issues or bugs with the CLI? How do I report it?
- We appreciate all the reports on bugs or issues from the community!
- You may report an issue by going to this Here and next to the "Bug Report", click the button "Get Started"!
- If you wish to get in touch with us quicker, you may join our Discord server! The link is under the "Dev Isle Community" section
- I would like to make a feature request. Where do I do it?
- We are open to your suggestions for the CLI!
- If you'd like to make a new feature request, just head over here and next to the "Feature Request", click the button "Get Started"!
- I would like to make a pull request. How can I do it?
- We are open to pull requests for the CLI!
- Before making a pull request, be sure to read the contribution guidelines that also have the pull request guide.
Dev Isle Community
Are you interested in hanging out, contributing to our open-source repos and be a part of a good community? We would love for you to join us on our Discord.
- @shreyas1307 - Creator and Maintainer
- @endormi - Maintainer
- @munsterberg - Contributor
- @natedeploys - Contributor
- @kruzus - Contributor
- @jgiamanco - Contributor
The source code is released under the GPL-3.0 License.