Getting Started

Follow these steps to set up and run the project locally.

Prerequisites

Ensure you have the following installed on your system:

• Node.js: Download and install Node.js
• npm: Comes with Node.js, but you can also install npm separately
• yarn (optional): If you prefer to use Yarn, install it here
• TypeScript: This project uses TypeScript, and the necessary dependencies will be installed automatically.

Installation

1. Clone the repository:

   git clone https://github.com/S0Vishnu/react-production-project-boilerplate.git
   cd react-production-project-boilerplate

2. Cloning repository with User Credentials:

   git clone https://your_username:password@github.com/S0Vishnu/react-production-project-boilerplate.git
   cd react-production-project-boilerplate

   note: if password contains special charecters use:

   • @ → %40
   • : → %3A
   • / → %2F
   • ? → %3F
   • & → %26
   • = → %3D
   • ! → %21

3. Install the dependencies:

   npm install

4. Start server:

   npm start

5. Build the app for production:

   npm run build

6. Tests

   This project includes both unit tests using Jest and end-to-end (E2E) tests using Cypress. Here’s how you can run and manage these tests.

   Unit Tests (Jest) Unit tests are located in the src/tests/unit/ directory. They test individual components and functions to ensure they work as expected. Jest is used for running these tests.

   Running Unit Tests To run the unit tests, use the following command:

   npm run test

   End-to-End (E2E) Tests (Cypress) Cypress can be run in two modes

   1. Interactive Mode:

      npm run cypress:open

   2. Headless Mode:

      npm run cypress:run

Run Documentation(Docsify)

1. Installation (if needed):

   npm i docsify-cli -g

2. Run Command:

   docsify serve docs