README

Overview

The Eren\Lms package is a Laravel-based Learning Management System (LMS) that provides essential functionalities for managing courses, assignments, and video uploads. It supports instructor panels, Amazon S3 integration for video storage, and an admin approval system for publishing courses.

Features

• Instructor Panel: Allows instructors to upload complete courses, including assignments and videos.
• Amazon S3 Support: Videos can be uploaded to Amazon S3 for efficient storage and delivery.
• Admin Approval System: Uploaded courses remain unpublished until reviewed and approved by an admin.
• User Authentication: Supports login, registration, and password recovery.
• Middleware Support: Includes admin and authenticate middleware for access control.
• Publishable Assets: Provides configuration files, views, translations, migrations, and other resources.

Installation (Recommended)

1. Install the package via Composer:

   composer require eren/lms
   

   and place these routes in your Laravel service provider e.g. RouteServiceProvider function => boot

   // Tell Fortify to use your package's views
        Fortify::loginView(function () {
            return view('lms::auth.login');
        });
   
        Fortify::registerView(function () {
            return view('lms::auth.register');
        });
   
        // You can also customize other views like password reset, email verification, etc.
        Fortify::requestPasswordResetLinkView(function () {
            return view('lms::auth.forgot-password');
        });
   
        Fortify::resetPasswordView(function () {
            return view('lms::auth.reset-password');
        });
   

2. Publish the package assets:

   php artisan vendor:publish --tag=lms_config
   php artisan vendor:publish --tag=lms_views
   php artisan vendor:publish --tag=lms_assets
   php artisan vendor:publish --tag=lms_lang
   php artisan vendor:publish --tag=lms_admin
   php artisan vendor:publish --tag=lms_requests
   php artisan vendor:publish --tag=lms_rules
   php artisan vendor:publish --tag=lms_only_header_footer_sidebar
   php artisan vendor:publish --tag=lms_migrations

3. Run migrations:

   php artisan migrate
   

4. Handy Seeders

   php artisan db:seed --class=LanguageSeeder
   php artisan db:seed --class=CategoriesSeeder
   

Installation(Personlized)

Step 1: Install the anhskohbo/no-captcha Package

1. Install the Package: Run the following Composer command to install the package:

   composer require anhskohbo/no-captcha

2. Publish the Configuration File: Publish the package's configuration file to customize reCAPTCHA settings:

   php artisan vendor:publish --provider="Anhskohbo\NoCaptcha\NoCaptchaServiceProvider"

   This will create a nocaptcha.php file in the config directory.

Step 2: Set Up Google reCAPTCHA Keys

1. Get reCAPTCHA Keys:

   • Go to the Google reCAPTCHA Admin Console.
   • Register your site and get the Site Key and Secret Key.

2. Add Keys to .env: Add the keys to your .env file:

   NOCAPTCHA_SITEKEY=your_site_key_here
   NOCAPTCHA_SECRET=your_secret_key_here

3. Update config/nocaptcha.php: Ensure the nocaptcha.php configuration file uses the keys from the .env file:

   return [
       'sitekey' => env('NOCAPTCHA_SITEKEY', ''),
       'secret' => env('NOCAPTCHA_SECRET', ''),
   ];

Step 3: Publish Auth Views

If you want to customize the login page, publish the authentication views using the lms_auth_views tag.

1. Publish Auth Views: Run the following Artisan command:

   php artisan vendor:publish --tag=lms_auth_views

   This will copy the authentication views (e.g., login.blade.php, register.blade.php) to your resources/views/vendor/lms directory.

   Run migrations:

   php artisan vendor:publish --tag=lms_migrations
   php artisan migrate
   

Middleware

The package provides the following middleware:

• admin: Restricts access to admin-only sections.
• authenticate: Ensures authentication for protected routes.

Instructor Panel

• Instructors can upload full courses, including assignments and videos.
• Videos are stored on Amazon S3.
• The admin must approve courses before they become publicly accessible.

Course Display

• Currently, the package does not include course display functionality.
• You can create a query to build a course listing page.

Authentication

• The package supports login, registration, and forgot password functionalities.

License

This package is open-source and available under the MIT License.

Contribution

Feel free to contribute by submitting issues or pull requests to the GitHub repository.

Support

For any issues, open a GitHub issue or contact the package maintainer.