• Guides

  • Requirements
  • Tools & Technology Used
  • Directory Structure
  • How to run project locally ?

• Available Scripts

  • yarn install
  • yarn start
  • yarn test
  • yarn build
  • yarn format
  • yarn lint

• NodeJs must be installed in your computer and
• Yarn

• NodeJs
• Typescript
• React
• Next JS
• Redux ToolKit
• Tailwind
• SCSS Modules
• MSW
• Jest
• React Testing Library
• Husky
• Commit Lint

src:

• components contains UI Components
• contexts contains custom context APIs
• hooks contains custom hook code
• mocks contains mock apis integrations
• redux redux store (state management)
• styles global styles
• types contains custom types
• utils contains configuration setups
• pages contains next pages

• clone this repo
• open project in your editor (ex: vscode)
• in your terminal run yarn install to install packages
• run yarn start to start project locally

In the project directory, you can run:

To this command to install packages required to run this project

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.

Run Test

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

Check eslint errors

Format Code With Prettier