Bowling Game API with LLM Integration 🎳

This bowling game API project allows users to create games, record rolls, get the current score, and request a natural language summary using a Large Language Model (LLM). The game follows standard bowling rules, and the LLM summarizes the game state.

Installation and Setup

1. Clone the Repository

   git clone https://github.com/Unique-01/Bowling_Game_API.git
   cd Bowling_Game_API

2. Setting Up a Virtual Environment

   1. Create a Virtual Environment

      • Open your terminal or command prompt.

      python -m venv venv

      This command creates a new directory called venv in your project folder containing the virtual environment.

   2. Activate the Virtual Environment

      • For macOS and Linux:

        source venv/bin/activate

      • For Windows(Command Prompt):

        venv\Scripts\activate

      • For Windows (PowerShell):

        .\venv\Scripts\Activate

      Note: Make sure you have Python installed on your system. If you have multiple versions of Python installed, you might need to use python or python3 as per your installation.

3. Install Dependencies

   pip install -r requirements.txt

4. Set up Environmental variables
   Create a .env file in the project root directory with the following keys:

   SECRET_KEY=your-django-secret-key
   OPENAI_API_KEY=your-openai-api-key

   • SECRET_KEY: Django secret key for cryptography.
   • OPENAI_API_KEY: API key for accessing OpenAI's GPT model.

5. Apply Migrations

   python manage.py migrate

6. Run the server

   python manage.py runserver

API Endpoints

1. GET /games/

   • Description: Retrieve a list of created games.

   • Request Body: None

   • Response:

     [
         {
             "id": 1,
             "title": "Game title",
             "created_at": "2024-10-20T20:15:04.306397Z",
             "completed": false
         },
         {
             "id": 1,
             "title": "Game title",
             "created_at": "2024-10-20T20:15:04.306397Z",
             "completed": false
         }
     ]

2. POST /games/

   • Description: Create a new game

   • Request Body (Optional):

     {
         "title": "Game title"
     }

   • Response:

     {
         "id": 1,
         "title": "Game title",
         "created_at": "2024-10-20T20:15:04.306397Z",
         "completed": false
     }

3. POST /games/{game_id}/rolls/

   • Description: Record a roll for a specific game.

   • Request Body:

     {
         "knocked_down_pins": 5
     }

   • Response:

     {
         "message": "Roll recorded successfully",
         "data": {
             "id": 1,
             "game": 1,
             "frame": 1,
             "roll_number": 1,
             "knocked_down_pins": 5,
             "created_at": "2024-10-20T21:14:01.014099Z"
         }
     }

4. GET /games/{game_id}/score/

   • Description: Get the current score of the game.

   • Request Body: None

   • Response:

     {
         "game_id":1,
         "score": 5
     }

5. GET /games/{game_id}/summary/

   • Description: Get the summary of the current game.

   • Request Body: None

   • Response:

     {
         "game_id":1,
         "summary": "In Game ID 1, there has been 1 roll so far in Frame 1, where 5 pins were knocked down. The game is currently in progress."
     }

Testing

1. Run Tests: Use the Django manage.py command to run the test suite

   python manage.py test

2. Test Cases: The test suite covers the following cases:

   • Listing games.
   • Creating new games
   • Recording rolls
   • Handling edge cases like completed games, invalid rolls and nonexistent games.
   • Fetching scores
   • Generating natural language summaries using the LLM.