Skip to main content

ZÈYA API Backend

REST API backend for the ZÈYA item swapping mobile application built with Laravel 10.

📱 About​

This Laravel API serves the ZÈYA mobile app, providing authentication, item management, real-time chat, group functionality, swap transactions, analytics, and more. ZÈYA is a peer-to-peer item swapping platform that enables users to discover, like, and swap items with others in their community.

Version: 1.0
Framework: Laravel 10.10
PHP: 8.2+

📚 Documentation​

🚀 Quick Start​

# Install dependencies
composer install

# Setup environment
cp .env.example .env
php artisan key:generate
php artisan jwt:secret

# Run migrations
php artisan migrate

# Start server
php artisan serve

For detailed setup instructions, see Setup & Installation.

🏗️ Tech Stack​

  • Framework: Laravel 10.10
  • PHP: 8.1+
  • Authentication: JWT (tymon/jwt-auth) + Laravel Sanctum
  • Databases: MySQL/PostgreSQL (primary), MongoDB (search)
  • Cache/Queue: Redis
  • File Storage: AWS S3
  • Services: Firebase, Google BigQuery, Expo Push Notifications, Twilio

See Architecture for complete tech stack details.

✨ Key Features​

  • 🔐 JWT Authentication & OTP Verification
  • 📦 Product Management with Image Upload
  • ❤️ Swipe-based Matching System
  • 🔄 Swap Transaction Management
  • 👥 Groups & Communities
  • 💬 Real-time Chat (Firebase)
  • 🔔 Push Notifications (Expo)
  • 📊 Analytics & Insights
  • 👨‍💼 Admin Dashboard

See Features for detailed feature documentation and Push Notifications for notification system details.

📖 API Documentation​

Base URL: https://api.zeya.app/api/v1/

All endpoints are versioned under /api/v1/ prefix. See API Endpoints for complete documentation.

Authentication​

Most endpoints require JWT authentication:

Authorization: Bearer {your-jwt-token}

Response Format​

{
  "success": true,
  "data": { ... },
  "message": "Operation successful"
}

🧪 Testing​

# Run all tests
php artisan test

# Run with coverage
php artisan test --coverage

🔧 Development​

# Format code
php artisan pint

# Run queue worker
php artisan queue:work

# Clear cache
php artisan optimize:clear

See Development Guide for more details.

🚀 Deployment​

See Deployment Guide for production deployment instructions.

🤝 Contributing​

See Contributing Guide for code standards and workflow.

🔗 Related Services​

📝 License​

Proprietary - ZÈYA Application