This project was bootstrapped with Create React App.

Requirements

Since our project is using React library you need to install Node.js and npm on your terminal, so you will be able to finish the next guidelines.

Also, we highly recommend to use Yarn dependency manager to execute project command:

$ npm install -g yarn

Installation

To install required libraries you need to run this command:\

$ npm install

or

$ yarn install

Usage

After making sure of installing the necessary dependencies of our project, you can now run the application, therefore you need to execute this command:

$ npm run start

or

$ yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

If you want to run the Storybook and test the stories that you have implemented, you need to run this command

$ npm run storybook

or

$ yarn storybook

this will open the Storybook on the browser with this link http://localhost:9009.

Available Scripts

In the project directory, you can run:

Lint:

$ npm run lint 

or

$ yarn lint

Lint all javascript files in src folder.

$ npm run lint:fix 

or

$ yarn lint:fix

Lint all javascript files in src folder and fix warnings and errors.

$ npm run lint:summary

or

$ yarn lint:summary

Lint all javascript files in src folder and output a detailed summary.

Test:

$ npm run test 

or

$ yarn test

Execute all tests scripts of the project.

Build:

$ npm run build 

or

$ yarn build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.