Installation Guide

This guide will walk you through the process of setting up the application on your local development environment.

Prerequisites

Before you begin, ensure you have the following installed:

• PHP >= 8.0
• Composer
• Node.js & NPM
• Docker (optional, for containerized development)

Installation Steps

1. Clone the Repository

   git clone <your-repository-url>
   cd your-project-name

2. Install PHP Dependencies

   composer install

3. Environment Setup

   cp .env.example .env
   php artisan key:generate

4. Database Setup

   php artisan migrate
   php artisan db:seed

5. API Ready

   # Your Laravel API is now ready for frontend consumption
   # Frontend (Next.js) should be set up separately
   # API endpoints available at: /api/*
   # Documentation available at: /docs/admin and /docs/instructor

Docker Installation (Optional)

If you prefer using Docker:

1. Build and Start Containers

   ./vendor/bin/sail up -d

2. Run Migrations

   ./vendor/bin/sail artisan migrate

Verification

To verify your installation:

1. Start the development server:

   php artisan serve

2. Visit http://localhost:8000 in your browser

Troubleshooting

If you encounter any issues during installation, please check:

• PHP version compatibility
• Database credentials in .env
• Proper permissions on storage and bootstrap/cache directories