# OpenClassify A modern classified ads platform built with Laravel 12, FilamentPHP v5, and Laravel Modules โ€” similar to Letgo and Sahibinden. ## Features - ๐Ÿ›๏ธ **Classified Listings** โ€” Browse, search, and post ads across categories - ๐Ÿ—‚๏ธ **Categories** โ€” Hierarchical categories with icons - ๐Ÿ“ **Locations** โ€” Country and city management - ๐Ÿ‘ค **User Profiles** โ€” Manage your listings and account - ๐Ÿ” **Admin Panel** โ€” Full control via FilamentPHP v5 at `/admin` - ๐Ÿงญ **Frontend Panel** โ€” Authenticated users manage listings, profile, videos, favorites, and inbox at `/panel` - ๐Ÿงช **Demo Mode** โ€” Per-visitor PostgreSQL schema provisioning with seeded data and automatic cleanup - ๐ŸŒ **10 Languages** โ€” English, Turkish, Arabic, German, French, Spanish, Portuguese, Russian, Chinese, Japanese - ๐Ÿณ **Docker Ready** โ€” One-command production and development setup - โ˜๏ธ **GitHub Codespaces** โ€” Zero-config cloud development ## Tech Stack | Layer | Technology | |-------|-----------| | Framework | Laravel 12 | | Admin UI | FilamentPHP v5 | | Modules | nWidart/laravel-modules v11 | | Auth/Roles | Spatie Laravel Permission | | Frontend | Blade + TailwindCSS + Vite | | Database | PostgreSQL (required for demo mode) | | Cache/Queue | Database or Redis | ## Quick Start (Docker) ```bash # Clone the repository git clone https://github.com/openclassify/openclassify.git cd openclassify # Copy environment file cp .env.example .env # Start with Docker Compose (production-like) docker compose up -d # The application will be available at http://localhost:8000 ``` ### Default Accounts | Role | Email | Password | |------|-------|----------| | Admin | a@a.com | 236330 | | Member | b@b.com | 36330 | These accounts are seeded by `Modules\User\Database\Seeders\AuthUserSeeder`. In demo mode, demo preparation still auto-logs the visitor into the schema-local admin account. **Admin Panel:** http://localhost:8000/admin **Frontend Panel:** http://localhost:8000/panel --- ## Development Setup ### Option 1: GitHub Codespaces (Zero Config) 1. Click **Code โ†’ Codespaces โ†’ New codespace** on GitHub 2. Wait for the environment to build (~2 minutes) 3. The app starts automatically at port 8000 ### Option 2: Docker Development ```bash # Start development environment with hot reload docker compose -f docker-compose.dev.yml up -d # View logs docker compose -f docker-compose.dev.yml logs -f app ``` ### Option 3: Local (PHP + Node) **Requirements:** PHP 8.2+, Composer, Node 18+, PostgreSQL for demo mode ```bash # Install dependencies composer install npm install # Setup environment cp .env.example .env php artisan key:generate # Database (SQLite for quick start) touch database/database.sqlite php artisan migrate php artisan db:seed # Start all services (server + queue + vite) composer run dev ``` ## Demo Mode Demo mode is designed for isolated visitor sessions. When enabled, each visitor can provision a private temporary marketplace backed by its own PostgreSQL schema. ### Requirements - `DB_CONNECTION=pgsql` - `DEMO=1` - database-backed session / cache / queue drivers are supported and will stay on the public schema via `pgsql_public` If `DEMO=1` is set while the app is not using PostgreSQL, the application fails fast during boot. ### Runtime Behavior - On the first guest homepage visit, the primary visible CTA is a single large `Prepare Demo` button. - The homepage shows how long the temporary demo will live before automatic deletion. - Clicking `Prepare Demo` provisions a visitor-specific schema, runs `migrate` and `db:seed`, and logs the visitor into the seeded admin account. - The same browser reuses its active demo instead of creating duplicate schemas. - Demo lifetime defaults to `360` minutes from explicit prepare / reopen time. - Expired demos are removed by `demo:cleanup`, which is scheduled hourly. ### Environment ```env DB_CONNECTION=pgsql DEMO=1 DEMO_TTL_MINUTES=360 DEMO_SCHEMA_PREFIX=demo_ DEMO_COOKIE_NAME=oc2_demo DEMO_LOGIN_EMAIL=a@a.com DEMO_PUBLIC_SCHEMA=public ``` ### Commands ```bash php artisan migrate --force php artisan db:seed --force php artisan demo:prepare php artisan demo:cleanup ``` ### Panels | Panel | URL | Access | |-------|-----|--------| | Admin | `/admin` | Users with `admin` role | | Frontend Panel | `/panel` | All authenticated users | ### Roles (Spatie Permission) | Role | Access | |------|--------| | `admin` | Full admin panel access | --- ## Realtime Chat (Laravel Reverb) This project already uses Laravel Reverb + Echo for inbox and listing chat realtime updates. ### 1. Environment Set these values in `.env`: ```env BROADCAST_CONNECTION=reverb REVERB_APP_ID=480227 REVERB_APP_KEY=your_key REVERB_APP_SECRET=your_secret REVERB_HOST=localhost REVERB_PORT=8080 REVERB_SCHEME=http REVERB_SERVER_HOST=0.0.0.0 REVERB_SERVER_PORT=8080 VITE_REVERB_APP_KEY="${REVERB_APP_KEY}" VITE_REVERB_HOST="${REVERB_HOST}" VITE_REVERB_PORT="${REVERB_PORT}" VITE_REVERB_SCHEME="${REVERB_SCHEME}" ``` ### 2. Start Services Use one command: ```bash composer run dev ``` Or run separately: ```bash php artisan serve php artisan reverb:start --host=0.0.0.0 --port=8080 php artisan queue:listen --tries=1 --timeout=0 npm run dev ``` ### 3. How It Works in This Codebase - Private channel: `users.{id}.inbox` - Channel authorization: `Modules/Conversation/App/Providers/ConversationServiceProvider.php` - Broadcast events: - `InboxMessageCreated` (`.inbox.message.created`) - `ConversationReadUpdated` (`.inbox.read.updated`) - Frontend subscriptions: `Modules/Conversation/resources/assets/js/conversation.js` - Echo bootstrap: `resources/js/echo.js` ### 4. Quick Verification 1. Open two different authenticated sessions (for example `a@a.com` and `b@b.com`). 2. Go to `/panel/inbox` in both sessions. 3. Send a message from one session. 4. Confirm in the other session: - thread updates instantly, - inbox ordering/unread state updates, - header inbox badge updates. ### 5. Troubleshooting - No realtime updates: - check `php artisan reverb:start` is running, - check Vite is running (`npm run dev`) and assets are rebuilt. - Private channel auth fails (`403`): - verify user is authenticated in the same browser/session. - WebSocket connection fails: - verify `REVERB_HOST/PORT/SCHEME` and matching `VITE_REVERB_*` values, - run `php artisan optimize:clear` after env changes. --- ## Code Contributors

OpenClassify Logo

OpenClassify is a modular open source classified platform built with Laravel. - Website: [openclassify.com](https://openclassify.com) - Package: [openclassify/openclassify](https://packagist.org/packages/openclassify/openclassify) This project is maintained and improved by its contributors.

OpenClassify Contributors

## Creating a New Module ```bash php artisan module:make ModuleName ``` Then add to `modules_statuses.json`: ```json { "ModuleName": true } ``` --- ## Adding a Filament Resource to Admin Panel Resources are auto-discovered from `Modules/Admin/Filament/Resources/`. --- ## Language Support Languages are in `lang/{locale}/messages.php`. To add a new language: 1. Create `lang/{locale}/messages.php` 2. Switch language via: `GET /lang/{locale}` Supported locales: `en`, `tr`, `ar`, `de`, `fr`, `es`, `pt`, `ru`, `zh`, `ja` --- ## Running Tests ```bash php artisan test ``` --- ## Production Deployment ### Environment Variables ```env APP_ENV=production APP_DEBUG=false APP_URL=https://yourdomain.com DB_CONNECTION=mysql DB_HOST=your-db-host DB_DATABASE=openclassify DB_USERNAME=openclassify DB_PASSWORD=your-secure-password REDIS_HOST=your-redis-host CACHE_STORE=redis SESSION_DRIVER=redis QUEUE_CONNECTION=redis ``` ### Post-Deploy Commands ```bash php artisan migrate --force php artisan db:seed --force # Only on first deploy php artisan config:cache php artisan route:cache php artisan view:cache php artisan storage:link ```