135 lines
4.6 KiB
Markdown
135 lines
4.6 KiB
Markdown
<div align="center">
|
||
|
||
```
|
||
██████╗ ██████╗ ███╗ ██╗ ██████╗ ██████╗ ██████╗
|
||
██╔════╝ ██╔═══██╗ ████╗ ██║██╔═══██╗ ██╔════╝ ██╔═══██╗
|
||
██║ ███╗██║ ██║█████╗██╔██╗ ██║██║ ██║█████╗██║ ███╗██║ ██║
|
||
██║ ██║██║ ██║╚════╝██║╚██╗██║██║ ██║╚════╝██║ ██║██║ ██║
|
||
╚██████╔╝╚██████╔╝ ██║ ╚████║╚██████╔╝ ╚██████╔╝╚██████╔╝
|
||
╚═════╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝ ╚═════╝ ╚═════╝
|
||
```
|
||
|
||
**✨ Laravel 12 + Nova 5 Administration Platform ✨**
|
||
|
||
`━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━`
|
||
|
||
</div>
|
||
|
||
## 🎮 GETTING STARTED
|
||
|
||
<div align="center">
|
||
|
||
```
|
||
┌─────────────────────────────────────────────────────────────┐
|
||
│ ⚡ QUICK START ⚡ │
|
||
└─────────────────────────────────────────────────────────────┘
|
||
```
|
||
|
||
</div>
|
||
|
||
### Prerequisites
|
||
|
||
- 📦 PHP 8.2+
|
||
- 📦 Laravel Herd
|
||
- 📦 MySQL
|
||
- 📦 Composer
|
||
- 📦 Node.js & npm
|
||
|
||
### Installation
|
||
|
||
```bash
|
||
# Step 1: Install dependencies
|
||
composer install && npm install
|
||
|
||
# Step 2: Configure environment
|
||
cp .env.example .env
|
||
# Edit .env: set DB_DATABASE=go-no-go, APP_URL=http://go-no-go.test
|
||
|
||
# Step 3: Generate key
|
||
herd php artisan key:generate
|
||
|
||
# Step 4: Run migrations and seed
|
||
herd php artisan migrate:fresh --seed
|
||
|
||
# Step 5: Build assets
|
||
npm run build
|
||
```
|
||
|
||
### Quick Access
|
||
|
||
```bash
|
||
# Auto-login as test user (local only)
|
||
open http://go-no-go.test/login-jonathan
|
||
|
||
# Admin panel
|
||
open http://go-no-go.test/cp
|
||
```
|
||
|
||
<p align="center">
|
||
<code>━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━</code>
|
||
</p>
|
||
|
||
## 📺 FEATURES
|
||
|
||
- 🔐 **Two-Factor Authentication** – Fortify-powered 2FA for admin accounts
|
||
- ✉️ **Email Verification** – Required for Nova access
|
||
- 🛡️ **Nova 5 Admin Panel** – Full administration at `/cp`
|
||
- 👤 **Test User Seeder** – Quick setup with `JonathanSeeder`
|
||
- 🚀 **Auto-Login Route** – `/login-jonathan` for local development
|
||
|
||
<p align="center">
|
||
<code>═══════════════════════════════════════════════════════════════</code>
|
||
</p>
|
||
|
||
## 📼 DOCUMENTATION
|
||
|
||
<table>
|
||
<tr>
|
||
<td width="50%">
|
||
|
||
### 📁 Core Docs
|
||
| File | Description |
|
||
|------|-------------|
|
||
| [`docs/index.md`](docs/index.md) | Master documentation index |
|
||
| [`database/schema.md`](database/schema.md) | Database schema reference |
|
||
| [`CLAUDE.md`](CLAUDE.md) | AI assistant project instructions |
|
||
|
||
</td>
|
||
<td width="50%">
|
||
|
||
### 🤖 Sub-Agents
|
||
| Agent | Purpose |
|
||
|-------|---------|
|
||
| `code-style-reviewer` | Code standards enforcement |
|
||
| `laravel-php-code-writer` | PHP code implementation |
|
||
| `laravel-nova-code-writer` | Nova resource management |
|
||
| `phpunit-code-writer` | PHPUnit test creation |
|
||
| `vue-code-writer` | Vue.js component building |
|
||
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<p align="center">
|
||
<code>━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━</code>
|
||
</p>
|
||
|
||
## 🌴 CONFIGURATION
|
||
|
||
| Setting | Value |
|
||
|---------|-------|
|
||
| Admin Panel | `/cp` |
|
||
| Database | `go-no-go` (MySQL) |
|
||
| Local URL | `http://go-no-go.test` |
|
||
| Test User | `jonathan@blijnder.nl` / `secret` |
|
||
|
||
<div align="center">
|
||
|
||
`═══════════════════════════════════════════════════════════════`
|
||
|
||
**Made with 💜 and mass amounts of ☕**
|
||
|
||
*🌴 Stay rad! 🌴*
|
||
|
||
</div>
|