Getting Started

UBold React is created using Create React App (CLI).

In case if you don't know - Create React App is a tool built by Facebook to help developers build react applications with simply just one command. It set up and configures everything automatically and so you don't need to configure anything manually (e.g. No need to install and configure tools like webpack or babel). they are preconfigured by creating react app.

Prerequisites

Please follow the below steps to install and setup all prerequisites:

• Nodejs

  Make sure to have the Node.js installed & running in your computer. If you already have installed nodejs on your computer, you can skip this step

• Yarn

  Make sure to have the Yarn installed & running in your computer. If you already have installed yarn on your computer, you can skip this step

• Git

  Make sure to have the Git installed & running in your computer. If you already have installed git on your computer, you can skip this step

Installation

To setup UBold React, follow the below-mentioned steps:

• Install Prerequisites

  Make sure to have all the above prerequisites installed & running on your computer

• Install Dependencies

  Open your terminal, go to your folder and enter the command yarn. This would install all required dependencies in node_modules folder. And now, you are ready to run the UBold React for the first time.

  • Check compatible version of node-sass ( Node version support policy ) :

    Open your terminal, to checkout your Node.js version, and enter the command node -v

    For Example, If your Node.js version is 16+ then install the node-sass version according (i.e. 6.0+). To change node-sass version, Open your terminal, go to your folder and enter the command yarn add node-sass@6.0+

    Below is a quick guide for minimum and maximum supported versions of node-sass:

    NodeJS	Supported node-sass version
    Node 17	7.0+
    Node 16	6.0+
    Node 15	5.0+, <7.0
    Node 14	4.14+
    Node 13	4.13+, <5.0
    Node 12	4.12+
    Node 11	4.10+, <5.0
    Node 10	4.9+, <6.0
    Node 8	4.5.3+, <5.0
    Node <8	<5.0

After you finished with above steps, you can run the following commands to run project locally or build for production use:

Command	Description
yarn start	Runs the project locally, starts the development server and watches for any changes in your code, including your components, sass, etc. The development server is accessible at http://localhost:3000.
yarn build	It will create a build folder inside your folder. It bundles React with production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes. Your app is now ready to be deployed.