Overview: CricNRR is an application designed to calculate the Net Run Rate (NRR) of a cricket team, assisting them in strategizing their performance to improve their position in the points table.
CricNRR allows users to input specific match-related data to determine the margin by which their team must win the next match to achieve a desired position. The application also evaluates whether winning a match will enable the team to reach their desired position in the points table.
Users are required to provide the following information:
- Your Team: Name of the team for which the NRR is being calculated.
- Opposition Team: Name of the opposing team.
- Match Format: Specify the number of overs in the match.
- Desired Position: The desired position for your team in the points table.
- Toss Result: Indicate whether your team is batting first or bowling first.
- Match Scores:
- Runs scored if batting first.
- Runs conceded if bowling first.
The application is developed using the following technologies:
- Backend: Node.js
- Frontend: React
- Libraries and Tools:- Express (Node.js framework)
- Joi (Validation library)
- Concurrently (for running multiple commands)
- Nodemon (for automatic server restarts)
- Vite (for frontend development)
To set up the CricNRR project locally, ensure that you have Node.js and Git installed on your machine. Follow these steps:
- Navigate to the desired directory where you want to clone the CricNRR repository using your command line interface (CLI):
cd PATH_TO_THE_DIRECTORY
- Clone the CricNRR repository:
git clone https://github.com/mihirkabra/CricNRR.git
- Change to the project directory:
cd CricNRR
- Install top-level dependencies:
npm install
- Navigate to the backend folder:
cd backend
- Install backend dependencies:
npm install
- Return to the project root directory:
cd ..
- Navigate to the frontend folder:
cd frontend/cricnrr
- Install frontend dependencies:
npm install
You're done with the setup! Follow along to run the project
- Return to the project root directory:
cd ..
cd ..
- Run the project:
npm start