IPL-Dashboard

A web application dashboard to view Indian Premier League (IPL) teams and match details, built with Spring Boot and React.

Table of Contents

1. Installation
2. Usage
3. Credits
4. Screenshots
5. Technologies Used
6. API Reference
7. Contact

Installation

Ensure you have the following installed on your machine:

Backend:

• Java: Version 11
• Maven: Version 3.6 (or newer)
• Spring Boot: Version 2.4.4

Frontend:

• Node.js: Version 14 (or newer)
• React: Version 18.2.0

Instructions:

1. Navigate to the IPL-Dashboard/src/frontend directory.
2. Create a .env file and define these parameters: REACT_APP_DATA_START_YEAR=2008, REACT_APP_DATA_END_YEAR=2020, and REACT_APP_API_ROOT_URL=. The last parameter can be "//localhost:8080" when developing locally.
3. Run npm install to install dependencies.
4. Run npm run build to build the frontend application. The build files will be copied to the Spring application directory.
5. Navigate back to the project root directory.
6. Run mvn install to install backend dependencies.
7. Run mvn spring-boot:run to start the Spring application.
8. Once the application is running, open your web browser and navigate to http://localhost:8080 to access the IPL Dashboard.

Deployment:

• The application is deployed on AWS. (At the moment, the server is turned off.)

Usage

The application serves as a dashboard for viewing IPL teams and matches. Users can navigate through different teams, view team details, and see match details for a specified year.

Credits

This project was created following a tutorial series by Java Brains on YouTube.

• Channel: Java Brains
• Playlist: IPL Dashboard - Spring Boot + React Full Stack development

Screenshots

Technologies Used

• Backend:

  • Java
  • Spring Boot
  • Spring Batch
  • Maven
  • HSQLDB

• Frontend:

  • React
  • Node.js

• Deployment:

  • AWS

API Reference

• Backend API endpoints are exposed for fetching team and match data, as defined in the TeamController class.

Contact

• Email: hamidreza74hrr@yahoo.com
• LinkedIn: Hamid Reza Rezaei