Cricket Stat - Game Engine Service

Project Overview

The Cricket Stat Game Engine Service is a backend application that provides functionality for managing cricket matches, teams, and player profiles. This service is part of the Cricket Stat application and handles match scheduling, player profile management, and team information.

Table of Contents

• Project Overview
• Setup Instructions
• Run the Application
• Access the Application
• API Documentation
  • MatchController
  • MatchSchedulingController
  • PlayerController
  • TeamController
  • TournamentController
• Testing

Setup Instructions

1. Clone the Repository

   git clone https://github.com/mohan-277/engine-service.git
   cd cricket-stat-game-engine-service
   

Setup Instructions

1. Ensure Java 17 or Higher

   Make sure you have Java 11 or higher installed on your machine.

   2. Install Dependencies

      Use Maven to install the required dependencies:

      mvn install
      

Run the Application

To start the application, use the following command:

mvn spring-boot:run

Access the Application

Once the application is running, you can access it at the following URL:

[http://localhost:8080](http://localhost:8080)

API Documentation

For detailed API documentation, including endpoints, request/response formats, and examples, please refer to the following link:

API Documentation

Testing

Running Tests

To ensure the application is working as expected, you can run the unit and integration tests using Maven. To execute the tests, use the following command:

mvn test

Explanation:

• ## Run the Application: This creates a level 2 heading for the "Run the Application" section.
• To start the application, use the following command:: This is a paragraph describing what to do.
• bash`** and **: These lines denote the beginning and end of a code block, specifically for shell commands.
• ## Access the Application: This creates a level 2 heading for the "Access the Application" section.
• Once the application is running, you can access it at the following URL:: This is a paragraph describing how to access the application.
• [http://localhost:8080](http://localhost:8080): This creates a hyperlink to the URL.

Ensure that you have the closing code block delimiter (```) after your shell command to separate it from the following text.