Getting Started

This guide walks you through installing, configuring, and using Omega Shop for the first time.

Installation

Follow these steps to set up a local development environment for Omega Shop.

# Clone the repository
git clone <repo-url> omega-shop && cd omega-shop

# Install PHP dependencies
composer install

# Install Node dependencies
npm install

# Copy environment file
cp .env.example .env

# Generate application key
php artisan key:generate

Configuration

After installation, complete these configuration steps to enable all platform features:

1. Configure Stripe keys (STRIPE_KEY, STRIPE_SECRET, STRIPE_WEBHOOK_SECRET) for payment processing
2. Set up Meilisearch and configure SCOUT_DRIVER=meilisearch, MEILISEARCH_HOST, MEILISEARCH_KEY for full-text search
3. Set up Google and Facebook OAuth apps and add client IDs/secrets for social login (optional)
4. Configure AWS S3 credentials for production file storage (optional, falls back to local disk)
5. Install and configure ClamAV for virus scanning on file uploads (optional)
6. Set up Vonage credentials for SMS notifications (optional)
7. Configure Sentry DSN for error monitoring (optional)
8. Run php artisan horizon to start the queue worker for background jobs
9. Set up a cron entry for Laravel scheduler: * * * * * php /path/to/artisan schedule:run >> /dev/null 2>&1

Environment Variables

Required Variables

Search & Integrations

Social Login

Notifications

AWS & Storage

Monitoring & Security

Deployment

Basic Usage Flow

The typical workflow for Omega Shop follows these steps:

1. Admin creates products — Admins create products (digital, service, or physical) with media, pricing tiers, and specifications via the Filament panel.
2. Stripe sync — Products are synced to Stripe automatically upon approval.
3. Customer browsing — Customers browse the catalog via the API or mobile app, with full-text search and category filtering.
4. Cart management — Customers add items to their cart or wishlist.
5. Checkout — At checkout, the customer selects billing details and delivery address, then pays via Stripe.
6. Digital delivery — For digital products, the customer receives license keys and download links in their purchase history.
7. Physical fulfillment — For physical products, the order moves through status stages (Pending, Processing, Completed).
8. Admin management — Admins manage orders, users, and integrations from the Filament dashboard.
9. Multi-channel selling — Products optionally sync to Shopify/WooCommerce for multi-channel selling.

API Examples

The REST API (v1) uses Sanctum token authentication. Below are common API operations.

curl -X POST https://your-domain.com/api/v1/auth/register \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "name": "John Doe",
    "email": "john@example.com",
    "password": "securepassword",
    "password_confirmation": "securepassword"
  }'

curl -X GET "https://your-domain.com/api/v1/products?search=wordpress+theme&per_page=20" \
  -H "Accept: application/json"

curl -X POST https://your-domain.com/api/v1/cart \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {token}" \
  -d '{
    "product_id": 1,
    "quantity": 1,
    "license_type": "extended"
  }'

curl -X POST https://your-domain.com/api/v1/checkout \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {token}" \
  -d '{
    "billing_detail_id": 1,
    "delivery_address_id": 2
  }'

curl -X GET https://your-domain.com/api/v1/downloads/42/url \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {token}"