Filament admin setup
This commit is contained in:
98
README.md
98
README.md
@@ -1,61 +1,65 @@
|
||||
<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
|
||||
# Skunk Lounge - Self-Hosted Fake Casino
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
|
||||
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
|
||||
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
|
||||
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
|
||||
</p>
|
||||
Skunk Lounge is a self-hosted, fake casino website for personal entertainment, mimicking the look and feel of real casinos like XXX. It uses fake currency only—no real money or payments. Built with Laravel for the backend, Filament for the admin panel, and Docker for easy deployment.
|
||||
|
||||
## About Laravel
|
||||
## Features
|
||||
- **Casino Lobby**: Game selection grid with thumbnails (slots, plinko, wheel, card games from open-source repos).
|
||||
- **User Accounts**: Signup/login, balance management, promo codes for fake deposits.
|
||||
- **Admin Interface**: Manage users, balances, promos, games (odds, bets), stats (wins/losses with charts).
|
||||
- **Games**: Integration-ready for open-source GitHub repos (e.g., Plinko with matter.js, slots, card games from Diablo-Lounge).
|
||||
- **Chat**: Real-time lobby and per-game chat using Socket.io or Pusher.
|
||||
- **Security**: Server-side bet calculations, hashing for integrity, audit logs.
|
||||
- **Database**: PostgreSQL for users, transactions, promos, games.
|
||||
- **Containers**: Docker for app and Postgres.
|
||||
|
||||
Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
|
||||
## Prerequisites
|
||||
- Docker and Docker Compose.
|
||||
- PHP 8.3+, Composer, Node.js (for local dev).
|
||||
- Gitea for repo (optional).
|
||||
|
||||
- [Simple, fast routing engine](https://laravel.com/docs/routing).
|
||||
- [Powerful dependency injection container](https://laravel.com/docs/container).
|
||||
- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
|
||||
- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
|
||||
- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
|
||||
- [Robust background job processing](https://laravel.com/docs/queues).
|
||||
- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
|
||||
## Setup
|
||||
1. **Clone Repo**:
|
||||
|
||||
Laravel is accessible, powerful, and provides tools required for large, robust applications.
|
||||
```
|
||||
git clone https://git.skunkhotel.com/arriej/Skunk-Lounge.git
|
||||
cd Skunk-Lounge
|
||||
```
|
||||
|
||||
## Learning Laravel
|
||||
2. **Configure .env**:
|
||||
- Copy `.env.example` to `.env`.
|
||||
- Update DB credentials, Pusher keys, secret key (run `docker compose exec app php artisan key:generate`).
|
||||
|
||||
Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
|
||||
3. **Build and Run Containers**:
|
||||
```
|
||||
docker compose build
|
||||
docker compose up -d
|
||||
docker compose exec app php artisan key:generate
|
||||
docker compose exec app php artisan migrate --seed
|
||||
```
|
||||
|
||||
You may also try the [Laravel Bootcamp](https://bootcamp.laravel.com), where you will be guided through building a modern Laravel application from scratch.
|
||||
4. **Access**:
|
||||
- App: http://localhost:8000
|
||||
- Admin: http://localhost:8000/admin (register first account for admin role).
|
||||
|
||||
If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
|
||||
## Usage
|
||||
- **User Side**: Register, use promo codes (e.g., START100), select games from lobby, bet fake $, chat.
|
||||
- **Admin Side**: Manage users/balances, games/odds, promos, view stats/logs.
|
||||
- **Adding Games**: Copy GitHub repo code/assets to `public/games`, hook to /api/bet.
|
||||
|
||||
## Laravel Sponsors
|
||||
## Development
|
||||
- **Edit Files**: Use Code Server/VS Code.
|
||||
- **Commit to Gitea**: `git add . && git commit -m "Message" && git push`.
|
||||
- **Build Containers with Komodo**: Use Komodo's Docker tools or CLI: `docker compose build`.
|
||||
- **Local Testing**: `docker compose exec app php artisan serve --host=0.0.0.0` (access via port 8000).
|
||||
- **Extensions**: Add PHP extensions in Dockerfile if needed.
|
||||
|
||||
We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the [Laravel Partners program](https://partners.laravel.com).
|
||||
|
||||
### Premium Partners
|
||||
|
||||
- **[Vehikl](https://vehikl.com)**
|
||||
- **[Tighten Co.](https://tighten.co)**
|
||||
- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
|
||||
- **[64 Robots](https://64robots.com)**
|
||||
- **[Curotec](https://www.curotec.com/services/technologies/laravel)**
|
||||
- **[DevSquad](https://devsquad.com/hire-laravel-developers)**
|
||||
- **[Redberry](https://redberry.international/laravel-development)**
|
||||
- **[Active Logic](https://activelogic.com)**
|
||||
|
||||
## Contributing
|
||||
|
||||
Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
|
||||
|
||||
## Security Vulnerabilities
|
||||
|
||||
If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed.
|
||||
## Clean Up and Maintenance
|
||||
- Remove unused Laravel files (e.g., default tests).
|
||||
- Update README with custom features.
|
||||
- Security: All bets server-side; add CSRF, rate-limiting as needed.
|
||||
|
||||
## License
|
||||
MIT
|
||||
|
||||
The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
|
||||
## Disclaimer
|
||||
For entertainment only—no real money. Use responsibly.
|
||||
Reference in New Issue
Block a user