casino/README.md

Casino Gaming Platform

An online gaming platform offering various casino-style games with virtual currency support. This project features a modern tech stack with Angular frontend, Spring Boot backend, and complete user authentication.

Please refer to our Style Guide for design guidelines and component standards.

Features

• Multiple casino games: Poker, Blackjack, Slots, Plinko, Liars Dice, and Lootboxes
• User authentication and account management via Keycloak
• Virtual currency deposit system using Stripe payments
• Transaction history tracking
• Responsive modern UI built with Angular and TailwindCSS

Tech Stack

Frontend

• Angular 18
• TailwindCSS
• Keycloak integration
• Stripe payment integration

Backend

• Spring Boot (Java)
• PostgreSQL database
• Keycloak for authentication/authorization
• Stripe API for payment processing

Infrastructure

• Docker containerization for all services

Getting Started

Prerequisites

• Docker
• Docker Compose (included with Docker Desktop for Windows and Mac)
• Java JDK 17+
• Node.js 18+

Setting Up the Environment

1. Clone the repository

git clone <repository-url>
cd casino

2. Start the Docker services

cd docker
docker-compose up -d

This will start:

• PostgreSQL database
• Keycloak authentication server

Running the Backend

1. Navigate to the backend directory

cd backend

2. Start the Spring Boot application

./gradlew bootRun

The backend will be available at:

• API endpoint: http://localhost:8080
• Swagger documentation: http://localhost:8080/swagger

Running the Frontend

1. Navigate to the frontend directory

cd frontend

2. Install dependencies

npm install

3. Start the development server

npm run dev

The frontend will be available at http://localhost:4200

Database Management

Postgres Management

Database cleanup (if needed)

cd docker
docker-compose down
docker volume rm local_lf8_starter_postgres_data
docker-compose up -d

Setting up IntelliJ Database View

1. Run the Docker container with PostgreSQL database
2. Open application.properties in the resources folder and copy the database URL
3. Open the Database tab in IntelliJ
4. Click on the database icon with key in the Database toolbar
5. Click the plus sign and select "Datasource from URL"
6. Paste the DB URL and select PostgreSQL driver, confirm with OK
7. Enter username lf8_starter and password secret
8. In the Schemas tab, uncheck all options and only check lf8_starter_db and public

Authentication

The application uses Keycloak for authentication. To get a bearer token for API testing:

1. Open requests/getBearerToken.http
2. Click the green arrow next to the request
3. Copy the access_token from the response

Development Guidelines

Commit Message Format

We follow semantic commit messages to maintain clear project history.

Format: <type>(<scope>): <subject>

Where <type> is one of:

• feat: New feature
• fix: Bug fix
• docs: Documentation changes
• style: Formatting, missing semicolons, etc; no code change
• refactor: Code refactoring
• test: Adding or refactoring tests
• chore: Updating build tasks, etc; no production code change

Examples:

feat: add user balance display
fix(auth): resolve token expiration issue
docs: update API documentation

References:

• Conventional Commits
• Semantic Commit Messages

License

MIT License

Copyright (c) 2025 Casino Gaming Platform

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.