chore: Update some README's
All checks were successful
CI / Get Changed Files (pull_request) Successful in 10s
Label PRs based on size / Check PR size (pull_request) Successful in 24s
Pull Request Labeler / labeler (pull_request_target) Successful in 10s
CI / oxlint (pull_request) Successful in 40s
CI / prettier (pull_request) Successful in 46s
CI / eslint (pull_request) Successful in 50s
CI / test-build (pull_request) Successful in 1m17s
Claude PR Review / claude-code (pull_request) Successful in 1m29s
CI / Docker frontend validation (pull_request) Successful in 15s
CI / Docker backend validation (pull_request) Successful in 14s
CI / Backend Tests (pull_request) Successful in 2m21s
CI / Checkstyle Main (pull_request) Successful in 1m49s
All checks were successful
CI / Get Changed Files (pull_request) Successful in 10s
Label PRs based on size / Check PR size (pull_request) Successful in 24s
Pull Request Labeler / labeler (pull_request_target) Successful in 10s
CI / oxlint (pull_request) Successful in 40s
CI / prettier (pull_request) Successful in 46s
CI / eslint (pull_request) Successful in 50s
CI / test-build (pull_request) Successful in 1m17s
Claude PR Review / claude-code (pull_request) Successful in 1m29s
CI / Docker frontend validation (pull_request) Successful in 15s
CI / Docker backend validation (pull_request) Successful in 14s
CI / Backend Tests (pull_request) Successful in 2m21s
CI / Checkstyle Main (pull_request) Successful in 1m49s
This commit is contained in:
parent
feb67c708e
commit
5d600a4b21
2 changed files with 217 additions and 51 deletions
|
@ -1,18 +1,106 @@
|
|||
# Casino Gaming Platform - Frontend
|
||||
|
||||
This is the frontend application for the Casino Gaming Platform. It's built with Angular 18 and TailwindCSS, providing a responsive and modern UI for the casino gaming experience.
|
||||
A modern Angular 20 casino gaming platform featuring multiple games including Blackjack, Coinflip, Dice, Slots, and Lootboxes. Built with Angular 20, TailwindCSS 4, and powered by Bun for fast development.
|
||||
|
||||
## Development
|
||||
## 🎮 Features
|
||||
|
||||
### Commands
|
||||
- **Multiple Games**: Blackjack, Coinflip, Dice, Slots, Lootboxes
|
||||
- **User Authentication**: OAuth2, email verification, password recovery
|
||||
- **Real-time Gaming**: Interactive game mechanics with animations
|
||||
- **Payment Integration**: Stripe integration for deposits
|
||||
- **Responsive Design**: Mobile-first design with TailwindCSS
|
||||
- **Audio Experience**: Game sounds and audio feedback
|
||||
- **Transaction History**: Complete betting and transaction tracking
|
||||
|
||||
- **Build**: `bun run build` or `bunx @angular/cli build`
|
||||
- **Start Dev Server**: `bun run start` or `bunx @angular/cli serve --proxy-config src/proxy.conf.json`
|
||||
- **Format Code**: `bun run format` or `prettier --write "src/**/*.{ts,html,css,scss}"`
|
||||
- **Lint**: `bun run lint` or `ng lint`
|
||||
- **Test**: `bun run test` or `bunx @angular/cli test`
|
||||
## 🚀 Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- [Bun](https://bun.sh/) (recommended) or Node.js 18+
|
||||
- Angular CLI 20+
|
||||
|
||||
### Installation
|
||||
|
||||
```bash
|
||||
# Install dependencies
|
||||
bun install
|
||||
|
||||
# Start development server
|
||||
bun run start
|
||||
```
|
||||
|
||||
The app will be available at `http://localhost:4200`
|
||||
|
||||
## 📋 Commands
|
||||
|
||||
### Development
|
||||
- **Start Dev Server**: `bun run start` - Starts dev server with proxy configuration
|
||||
- **Build**: `bun run build` - Production build
|
||||
- **Watch Build**: `bun run watch` - Development build with file watching
|
||||
|
||||
### Code Quality
|
||||
- **Format**: `bun run format` - Format code with Prettier
|
||||
- **Format Check**: `bun run format:check` - Check code formatting
|
||||
- **Lint**: `bun run lint` - Run ESLint
|
||||
- **OxLint**: `bun run oxlint` - Run OxLint with strict warnings
|
||||
|
||||
### Testing
|
||||
- **Test All**: `bun run test` - Run all tests with Karma/Jasmine
|
||||
- **Test Single File**: `bunx @angular/cli test --include=path/to/test.spec.ts`
|
||||
|
||||
## 🛠️ Technology Stack
|
||||
|
||||
### Core
|
||||
- **Angular 20**: Latest Angular framework with standalone components
|
||||
- **TypeScript 5.8**: Strongly typed JavaScript
|
||||
- **RxJS 7.8**: Reactive programming for HTTP and state management
|
||||
|
||||
### Styling & UI
|
||||
- **TailwindCSS 4**: Utility-first CSS framework
|
||||
- **PostCSS**: CSS processing and optimization
|
||||
- **FontAwesome**: Icon library with Angular integration
|
||||
|
||||
### Animation & Interaction
|
||||
- **GSAP**: High-performance animations
|
||||
- **CountUp.js**: Number animation effects
|
||||
- **Custom Audio Service**: Game sound effects and feedback
|
||||
|
||||
### Development Tools
|
||||
- **Bun**: Fast JavaScript runtime and package manager
|
||||
- **ESLint + Angular ESLint**: Code linting with Angular-specific rules
|
||||
- **OxLint**: Fast Rust-based linter
|
||||
- **Prettier**: Code formatting
|
||||
- **Karma + Jasmine**: Testing framework
|
||||
|
||||
### Payment & APIs
|
||||
- **Stripe**: Payment processing integration
|
||||
- **Custom HTTP Interceptors**: API communication and error handling
|
||||
|
||||
## 🏗️ Architecture
|
||||
|
||||
### Project Structure
|
||||
```
|
||||
src/
|
||||
├── app/
|
||||
│ ├── feature/ # Feature modules
|
||||
│ │ ├── auth/ # Authentication (login, register, OAuth2)
|
||||
│ │ ├── game/ # Game modules (blackjack, coinflip, dice, slots)
|
||||
│ │ ├── lootboxes/ # Lootbox system
|
||||
│ │ └── deposit/ # Payment and deposits
|
||||
│ ├── model/ # Data models and interfaces
|
||||
│ ├── service/ # Core services (auth, user, transaction)
|
||||
│ └── shared/ # Shared components, directives, services
|
||||
├── environments/ # Environment configurations
|
||||
└── public/ # Static assets (images, sounds)
|
||||
```
|
||||
|
||||
### Key Components
|
||||
- **Game Components**: Modular game implementations with services
|
||||
- **Shared Components**: Reusable UI components (navbar, footer, modals)
|
||||
- **Services**: Business logic and API communication
|
||||
- **Guards**: Route protection and authentication
|
||||
- **Interceptors**: HTTP request/response handling
|
||||
|
||||
## Style Guide
|
||||
|
||||
### Color Palette
|
||||
|
|
Reference in a new issue