Gambling Simulation Game - Alpha Version

Welcome to the alpha version of our simple Gambling simulation game. This project allows users to engage in a game where they choose between true or false to win. Players can create games, set the game's name, number of players, entry fee, and the currency for the entry fee. Winners take all the money or share it amongst those who chose correctly. This document outlines how to get started, use the API, and test the game's functionality.

Features

• User Registration: Register users to participate in the game.
• Wallet Operations: Users can deposit and withdraw money in available currencies (USD, EUR) and check their balances.
• Game Creation: Create games with specific attributes like name, maximum players, entry fee, and currency.
• Player Registration: Register players for games.
• Game Play: Start the game and determine the winner.

Getting Started

Prerequisites

1. Ensure you have Go installed on your system to run or build the application.

2. Before running the project for the first time, it's essential to prepare your local environment. This includes setting up environment variables and performing any required configurations. To automate this process, we have provided a bash make init-local-env command that prepares everything you need to get started.

make init-local-env

This command will copy the .env.example file to a new .env file that you can then customize for your local setup. It may also perform additional setup tasks as defined in the Makefile.

Please make sure to review and update the .env file with your specific settings before starting the project to ensure it runs correctly in your local development environment.

Running the Application

To run the application directly:

go run main.go start

To build and run the application:

make build-app
./bin/app start

Use make help to view a list of available commands.

Testing With Make Commands

For convenience and to facilitate the testing process of the Gambling Game API, we've provided a series of make commands. These commands allow you to easily simulate actions such as registering users, making deposits and withdrawals, checking balances, creating games, registering players, and starting games. Below is a guide on how to use these commands with examples:

Register a User

To register a new user, you need to provide an email address:

make register-user email=newuser@example.com

Deposit Funds

To deposit funds into a user's account, specify the user (email), amount, and currency. The amount and currency are optional and default to 10 USD if not provided:

make deposit-funds user=newuser@example.com amount=25 currency=EUR

Using default values for amount and currency:

make deposit-funds user=newuser@example.com

Withdraw Funds

To withdraw funds from a user's account, you need to specify the user (email), and you can optionally specify the amount and currency:

make withdraw-funds user=newuser@example.com amount=15 currency=USD

Using default values for amount and currency:

make withdraw-funds user=newuser@example.com

Check Balance

To check the balance of a user's account, specify the user (email) and optionally the currency. The default currency is USD:

make check-balance user=newuser@example.com currency=USD

Using default values for currency:

make check-balance user=newuser@example.com

Create a Game

To create a game, you can specify maxPlayers, entryFee, and entryCurrency. If these parameters are not provided, default values are used:

make create-game maxPlayers=1 entryFee=2 entryCurrency=USD

Using default values for currency, maxPlayers and entryCurrency:

make create-game

Register a Player for a Game

To register a player for a game, you must provide the gameID, user (email), and optionally the playerChoice. The default playerChoice is false:

make register-player gameID={gameID} user=newuser@example.com playerChoice=true

Using default values for playerChoice:

make register-player gameID={gameID} user=newuser@example.com

Start a Game

To start a game, you need to provide the gameID:

make play-game gameID={gameID}

These commands provide a quick and easy way to test various functionalities of the API, enhancing the overall testing experience.

API Endpoints

The application provides the following RESTful endpoints:

• Create Game: POST /api/v1/game
• Register Players: POST /api/v1/game/register
• Play Game: POST /api/v1/game/play
• Register User: POST /api/v1/user
• Deposit Funds: POST /api/v1/wallet/deposit
• Withdraw Funds: POST /api/v1/wallet/withdraw
• Check Balance: GET /api/v1/wallet/balance

Testing the Game

Follow these steps to test the game functionality:

Register a User:

POST http://localhost:9092/api/v1/user

Body:

{
  "email": "user@gmail.com"
}

Deposit Funds:

POST http://localhost:9092/api/v1/wallet/deposit

Body:

{
  "userID": "user@gmail.com",
  "amount": 12.00,
  "currency": "USD"
}

Check Balance:

GET http://localhost:9092/api/v1/wallet/balance

Body:

{
  "userID": "user@gmail.com",
  "currency": "USD"
}

Withdraw Funds:

POST http://localhost:9092/api/v1/wallet/withdraw

Body:

{
  "userID": "user@gmail.com",
  "amount": 10.00,
  "currency": "USD"
}

Create a Game:

POST http://localhost:9092/api/v1/game

Body:

{
  "name": "game 1",
  "maxPlayers": 2,
  "entryFee": 2,
  "entryCurrency": "USD"
}

Register Players for the Game:

POST http://localhost:9092/api/v1/game/register

Body:

{
  "gameID": "{gameID}",
  "userID": "user@gmail.com",
  "playerChoice": false
}

Start the Game:

POST http://localhost:9092/api/v1/game/play

Body:

{
  "id": "{gameID}"
}

After the game concludes, you can check the balances of the winning players, along with their total wins and the date/time of their last win, paving the way for future expansions.

Future Work

• Implement more currencies and payment methods.
• Introduce more comprehensive player statistics.
• Expand the game rules and modes.