Skip to content

Latest commit

 

History

History
190 lines (138 loc) · 9.45 KB

README.md

File metadata and controls

190 lines (138 loc) · 9.45 KB
Raw

     _        _           ____                     _      ____  _      ___
    / \    __| |__   __  |  _ \  ___   __ _   ___ | |_   / ___|| |    |_ _|
   / _ \  / _` |\ \ / /  | |_) |/ _ \ / _` | / __|| __| | |    | |     | |
  / ___ \| (_| | \ V /_  |  _ <|  __/| (_| || (__ | |_  | |___ | |___  | |
 /_/   \_\\__,_|  \_/(_) |_| \_\\___| \__,_| \___| \__|  \____||_____||___|

Table of Contents

About

version downloads Test CodeQL

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.

Project's Purpose

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!

Be sure to check the repos in credits 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)

  • NPX: npx advanced-react-cli

Installing the CLI globally

  • NPM: npm i -g advanced-react-cli

  • Yarn: yarn global add advanced-react-cli

  • To invoke the CLI (Both NPM & Yarn) arc

Packages

The CLI currently has these packages available for installation:

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 accessibility such as React-A11y and React-Axe.
  • TypeScript and @types definitions for Node, React, React-Router, React-Redux and Jest

Running tests

Test:

npm run test or yarn test

Test coverage:

npm run test:coverage or yarn test:coverage

Credits

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:

FAQs

  1. How can I test this out?

  • If you'd like to try it out , Run the following command npx advanced-react-cli in 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 --version and depending on your package manager of choice, run npm --version or yarn --version. If you don't have it installed, please visit:

    • Git to download/install git.
    • NodeJS to download/install Node.Js (NPM gets installed with Node.Js).
    • Yarn to download/install Yarn Package Manager

  • 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 install for NPM users or yarn install for 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-cli or yarn run react-cli to get it working. And voila!

  1. 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
  1. 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"!
  1. 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.
  1. How can I run the documentation site?
  • The documentation site is built using docsify.
  • Install docsify if you haven't done that already npm i docsify-cli -g.
  • Run the site npm run docs.

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.

Authors

Maintainers

Contributors

License

The source code is released under the GPL-3.0 License.