Merge pull request #17 from TappNetwork/configuration-updates

configuration

Author: scottgrayson

README.md

@@ -1,3 +1,58 @@
+# Filament LMS
+An opinionated LMS plugin for Filament containing a user facing LMS panel and Resources for an existing admin panel
+
+## Installation
+### add the following to composer.json
+
+``` json
+"require": {
+    "tapp/filament-lms": "*",
+}
+```
+
+``` json
+"minimum-stability": "dev"
+```
+
+```json
+"repositories": {
+    "tapp/filament-lms": {
+        "type": "vcs",
+        "url": "https://github.com/tappnetwork/filament-lms"
+    },
+    "tapp/filament-form-builder": {
+        "type": "vcs",
+        "url": "https://github.com/tappnetwork/filament-form-builder"
+    }
+},
+```
+
+### publish 
+
+``` sh
+php artisan vendor:publish --provider="Tapp\FilamentLms\FilamentLmsServiceProvider"
+```
+
+run migrations after publishing
+
+### add plugin to admin panel
+This will create resources that allow admin to manage course material.
+
+``` php
+class AdminPanelProvider extends PanelProvider
+{
+    public function panel(Panel $panel): Panel
+    {
+        return $panel
+            ->plugins([
+                \Tapp\FilamentLms\Lms::make(),
+            ])
+    }
+}
+```
+
+
+
 # Development Reccomendations
 - create the directory {project}/packages
 - from within the packages directory, clone this repo

composer.json

@@ -36,6 +36,12 @@
         "phpstan/phpstan-phpunit": "^1.3",
         "spatie/laravel-ray": "^1.35"
     },
+    "repositories": {
+        "tapp/filament-form-builder": {
+            "type": "vcs",
+            "url": "https://github.com/tappnetwork/filament-form-builder"
+        }
+    },
     "scripts": {
         "post-autoload-dump": "@composer run prepare",
         "prepare": "@php vendor/bin/testbench package:discover --ansi",
@@ -58,11 +64,5 @@
                 "Tapp\\FilamentLms\\LmsPanelProvider"
             ]
         }
-    },
-    "repositories": {
-        "tapp/filament-form-builder": {
-            "type": "vcs",
-            "url": "https://github.com/tappnetwork/filament-form-builder"
-        }
     }
 }

config/filament-lms.php

@@ -0,0 +1,11 @@
+<?php
+
+return [
+    'theme' => 'default',
+    'font' => 'Poppins',
+    'home_url' => '/lms',
+    'brand_name' => 'LMS',
+    'brand_logo' => '',
+    'vite_theme' => '',
+    'colors' => [],
+];