initialize-react-app

initialize-react-app

Table of Contents

1. About The Project
2. Built With
3. Usage
4. Getting Started
   • Prerequisites
   • Installation
   • Contribution guidlines
5. Roadmap
6. License
7. Contact
8. Acknowledgements

About The Project

![Product Name Screen Shot][product-screenshot]

Initialize React App is a cli tool to generate and configure a react project easily with 0 configuration. Out of the box it supports creat-react-app, Next.js, Gatsby and Custom React Config along with suport for typescript. Following are the features that this cli can configure:

• Support for Create React App, Next.js, Gatsby, Custom React Config
• 0 config setup for ESLint, Prettier.
• Code easily with either Typescript of Javascript.
• Well organized directory structure.
• Setup custom hooks.
• Options to add Github Actions, License (License Type)

A list of commonly used resources that I find helpful are listed in the acknowledgements.

Built With

Following technologies are libraries are used for the development of this project.

• Node.js
• Typescript
• Inquirer
• ORM
• Create React App
• Next.js
• Gatsby

Usage

• Run the following command to initialize the cli npx initialize-react-app
• You'll be prompted to select a framework or custom webpack setup.
• After that proceed by entering the project name.
• If you plan to configure the project manually, you'll be prompted with a list of different questions.

Getting Started

To setup the project locally follow the steps below

Prerequisites

• Node.js

  # Homebrew
  brew install nodejs
  
  # Sudo apt
  sudo apt install nodejs
  
  # Packman
  pacman -S nodejs
  
  # Module Install
  dnf module install nodejs:<stream> # stream is the version
  
  # Windows (chocolaty)
  cinst nodejs.install
  

• Yarn

  npm install --global yarn

• Git

  # Homebrew
  brew install git

  # Sudo apt
  apt-get install git

  # Packman
  pacman -S git

  # Module Install (Fedora)
  dnf install git

Installation

1. Clone the repo

   git clone https://github.com/riteshsp2000/initialize-react-app.git

2. Install dependencies

   # Please use yarn over npm
   yarn install

3. Start the project

   yarn develop