Aded documentation module

Modules/Documentation/Config/config.php

@@ -0,0 +1,8 @@
+<?php
+
+return [
+    'name' => 'Documentation',
+    'features' =>
+     [
+     ],
+];

Modules/Documentation/Database/Seeders/DocumentationDatabaseSeeder.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Modules\Documentation\Database\Seeders;
+
+use Illuminate\Database\Seeder;
+use Illuminate\Database\Eloquent\Model;
+
+class DocumentationDatabaseSeeder extends Seeder
+{
+    /**
+     * Run the database seeds.
+     *
+     * @return void
+     */
+    public function run()
+    {
+        Model::unguard();
+
+        // $this->call("OthersTableSeeder");
+    }
+}

Modules/Documentation/Helpers/Helper.php

@@ -0,0 +1,12 @@
+<?php
+use Modules\Documentation\Support\ModuleInfo;
+
+if (! function_exists('documentation_feature_enabled')) {
+    /**
+     * Check if a feature is enabled in the config.
+     */
+    function documentation_feature_enabled(string $key): bool
+    {
+        return (bool) config(ModuleInfo::nameLower().".features.{$key}", false);
+    }
+}

Modules/Documentation/Http/Controllers/DocumentationController.php

@@ -0,0 +1,79 @@
+<?php
+
+namespace Modules\Documentation\Http\Controllers;
+
+use Illuminate\Contracts\Support\Renderable;
+use Illuminate\Http\Request;
+use Illuminate\Routing\Controller;
+
+class DocumentationController extends Controller
+{
+    /**
+     * Display a listing of the resource.
+     * @return Renderable
+     */
+    public function index()
+    {
+        return view('documentation::index');
+    }
+
+    /**
+     * Show the form for creating a new resource.
+     * @return Renderable
+     */
+    public function create()
+    {
+        return view('documentation::create');
+    }
+
+    /**
+     * Store a newly created resource in storage.
+     * @param Request $request
+     * @return Renderable
+     */
+    public function store(Request $request)
+    {
+        //
+    }
+
+    /**
+     * Show the specified resource.
+     * @param int $id
+     * @return Renderable
+     */
+    public function show($id)
+    {
+        return view('documentation::show');
+    }
+
+    /**
+     * Show the form for editing the specified resource.
+     * @param int $id
+     * @return Renderable
+     */
+    public function edit($id)
+    {
+        return view('documentation::edit');
+    }
+
+    /**
+     * Update the specified resource in storage.
+     * @param Request $request
+     * @param int $id
+     * @return Renderable
+     */
+    public function update(Request $request, $id)
+    {
+        //
+    }
+
+    /**
+     * Remove the specified resource from storage.
+     * @param int $id
+     * @return Renderable
+     */
+    public function destroy($id)
+    {
+        //
+    }
+}

Modules/Documentation/Providers/DocumentationServiceProvider.php

@@ -0,0 +1,155 @@
+<?php
+
+namespace Modules\Documentation\Providers;
+
+use Illuminate\Support\ServiceProvider;
+use Illuminate\Database\Eloquent\Factory;
+use Illuminate\Support\Facades\File;
+use Modules\Documentation\Support\ModuleInfo;
+use Config;
+
+class DocumentationServiceProvider extends ServiceProvider
+{
+    /**
+     * @var string $moduleName
+     */
+    protected string $moduleName = 'Documentation';
+
+    /**
+     * @var string $moduleNameLower
+     */
+    protected string $moduleNameLower = 'documentation';
+
+
+     /**
+      * Get the services provided by the provider.
+      *
+      * @return array
+      */
+    public function provides():array
+    {
+        return [];
+    }
+
+    /**
+     * Boot the application events.
+     *
+     * @return void
+     */
+    public function boot() : void
+    {
+        $this->registerTranslations();
+        $this->registerConfig();
+        $this->registerViews();
+        $this->registerHelpers();
+        $this->registerCommands();
+        $this->loadMigrationsFrom(module_path(ModuleInfo::name(), 'Database/Migrations'));
+    }
+
+    /**
+     * Register the service provider.
+     *
+     * @return void
+     */
+    public function register(): void
+    {
+        $this->app->register(RouteServiceProvider::class);
+    }
+
+    /**
+     * Register the helpers.
+     *
+     * @return void
+     */
+    protected function registerHelpers(): void
+    {
+        foreach (glob(__DIR__.'/../Helpers/*.php') as $filename) {
+            require_once $filename;
+        }
+    }
+
+     /**
+     * Dynamically Register Commands.
+     *
+     * @return void
+     */
+    public function registerCommands(): void
+       {
+           if (!$this->app->runningInConsole()) {
+               return;
+           }
+           $commandPath = __DIR__ . '/../Console';
+            $commands = collect(File::allFiles($commandPath))
+                 ->map(function ($file) {
+                     $class = 'Modules\\' . $this->moduleName . '\\Console\\' . $file->getFilenameWithoutExtension();
+                     return $class;
+                })
+                ->filter(function ($class) {
+                    return class_exists($class);
+                })
+                ->values()
+                ->all();
+            $this->commands($commands);
+        }
+
+    /**
+     * Register config.
+     *
+     * @return void
+     */
+    protected function registerConfig(): void
+    {
+        $this->publishes([
+            module_path(ModuleInfo::name(), 'Config/config.php') => config_path( ModuleInfo::nameLower(). '.php'),
+        ], 'config');
+        $this->mergeConfigFrom(
+            module_path(ModuleInfo::name(), 'Config/config.php'),  ModuleInfo::nameLower()
+        );
+    }
+
+    /**
+     * Register views.
+     *
+     * @return void
+     */
+    public function registerViews(): void
+    {
+        $viewPath = resource_path('views/modules/' . ModuleInfo::nameLower());
+        $sourcePath = module_path(ModuleInfo::name(), 'Resources/views');
+        $this->publishes([
+            $sourcePath => $viewPath
+        ], ['views',  ModuleInfo::nameLower() . '-module-views']);
+        $this->loadViewsFrom(array_merge($this->getPublishableViewPaths(), [$sourcePath]),  ModuleInfo::nameLower());
+    }
+
+    /**
+     * Register translations.
+     *
+     * @return void
+     */
+    public function registerTranslations(): void
+    {
+        $langPath = resource_path('lang/modules/' .  ModuleInfo::nameLower());
+
+        if (is_dir($langPath)) {
+            $this->loadTranslationsFrom($langPath,  ModuleInfo::nameLower());
+        } else {
+            $this->loadTranslationsFrom(module_path(ModuleInfo::name(), 'Resources/lang'), ModuleInfo::nameLower());
+        }
+    }
+
+    /**
+     * Regsiter View Paths
+     * @return array
+     */
+    private function getPublishableViewPaths(): array
+    {
+        $paths = [];
+        foreach (Config::get('view.paths') as $path) {
+            if (is_dir($path . '/modules/' . ModuleInfo::nameLower())) {
+                $paths[] = $path . '/modules/' . ModuleInfo::nameLower();
+            }
+        }
+        return $paths;
+    }
+}

Modules/Documentation/Providers/RouteServiceProvider.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace Modules\Documentation\Providers;
+
+use Illuminate\Support\Facades\Route;
+use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
+
+class RouteServiceProvider extends ServiceProvider
+{
+    /**
+     * The module namespace to assume when generating URLs to actions.
+     *
+     * @var string
+     */
+    protected $moduleNamespace = 'Modules\Documentation\Http\Controllers';
+
+    /**
+     * Called before routes are registered.
+     *
+     * Register any model bindings or pattern based filters.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        parent::boot();
+    }
+
+    /**
+     * Define the routes for the application.
+     *
+     * @return void
+     */
+    public function map()
+    {
+        $this->mapApiRoutes();
+
+        $this->mapWebRoutes();
+    }
+
+    /**
+     * Define the "web" routes for the application.
+     *
+     * These routes all receive session state, CSRF protection, etc.
+     *
+     * @return void
+     */
+    protected function mapWebRoutes()
+    {
+        Route::middleware('web')
+            ->namespace($this->moduleNamespace)
+            ->group(module_path('Documentation', '/Routes/web.php'));
+    }
+
+    /**
+     * Define the "api" routes for the application.
+     *
+     * These routes are typically stateless.
+     *
+     * @return void
+     */
+    protected function mapApiRoutes()
+    {
+        Route::prefix('api')
+            ->middleware('api')
+            ->namespace($this->moduleNamespace)
+            ->group(module_path('Documentation', '/Routes/api.php'));
+    }
+}

Modules/Documentation/Resources/views/index.blade.php

@@ -0,0 +1,9 @@
+@extends('documentation::layouts.master')
+
+@section('content')
+    <h1>Hello World</h1>
+
+    <p>
+        This view is loaded from module: {!! config('documentation.name') !!}
+    </p>
+@endsection

Modules/Documentation/Resources/views/layouts/master.blade.php

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8">
+        <meta http-equiv="X-UA-Compatible" content="IE=edge">
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+        <title>Module Documentation</title>
+
+       {{-- Laravel Mix - CSS File --}}
+       {{-- <link rel="stylesheet" href="{{ mix('css/documentation.css') }}"> --}}
+
+    </head>
+    <body>
+        @yield('content')
+
+        {{-- Laravel Mix - JS File --}}
+        {{-- <script src="{{ mix('js/documentation.js') }}"></script> --}}
+    </body>
+</html>

Modules/Documentation/Routes/api.php

@@ -0,0 +1,18 @@
+<?php
+
+use Illuminate\Http\Request;
+
+/*
+|--------------------------------------------------------------------------
+| API Routes
+|--------------------------------------------------------------------------
+|
+| Here is where you can register API routes for your application. These
+| routes are loaded by the RouteServiceProvider within a group which
+| is assigned the "api" middleware group. Enjoy building your API!
+|
+*/
+
+Route::middleware('auth:api')->get('/documentation', function (Request $request) {
+    return $request->user();
+});

Modules/Documentation/Routes/web.php

@@ -0,0 +1,16 @@
+<?php
+
+/*
+|--------------------------------------------------------------------------
+| Web Routes
+|--------------------------------------------------------------------------
+|
+| Here is where you can register web routes for your application. These
+| routes are loaded by the RouteServiceProvider within a group which
+| contains the "web" middleware group. Now create something great!
+|
+*/
+
+Route::prefix('documentation')->group(function() {
+    Route::get('/', 'DocumentationController@index');
+});

Modules/Documentation/Support/ModuleInfo.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Modules\Documentation\Support;
+
+class ModuleInfo
+{
+    protected static string $moduleName =  'Documentation';
+
+    /**
+     * defines the Module Name
+     * @return string
+     */
+    public static function name(): string
+    {
+        return static::$moduleName;
+    }
+
+    /**
+     * define the lowercase version
+     * @return string
+     */
+    public static function nameLower(): string
+    {
+        return strtolower(static::$moduleName);
+    }
+}

Modules/Documentation/composer.json

@@ -0,0 +1,29 @@
+{
+    "name": "mpba/documentation",
+    "description": "",
+    "authors": [
+        {
+            "name": "Mark Gregory",
+            "email": "mark.gregory@mpba.co.uk"
+        }
+    ],
+    "extra": {
+        "laravel": {
+            "providers": [],
+            "aliases": {
+
+            }
+        }
+    },
+    "autoload": {
+        "psr-4": {
+            "Modules\\Documentation\\": ""
+        },
+    "autoload-dev": {
+        "psr-4": {
+            "Tests\\": "tests/",
+            "Modules\\Documentation\\Tests\\": "modules/Documentation/Tests/"
+            }
+        }
+    }
+}

Modules/Documentation/module.json

@@ -0,0 +1,14 @@
+{
+    "name": "Documentation",
+    "alias": "documentation",
+    "version": "1.0.0",
+    "description": "",
+    "keywords": [],
+    "priority": 0,
+    "providers": [
+        "Modules\\Documentation\\Providers\\DocumentationServiceProvider"
+    ],
+    "aliases": {},
+    "files": [],
+    "requires": []
+}

Modules/Documentation/package.json

@@ -0,0 +1,17 @@
+{
+    "private": true,
+    "scripts": {
+        "dev": "npm run development",
+        "development": "cross-env NODE_ENV=development node_modules/webpack/bin/webpack.js --progress --hide-modules --config=node_modules/laravel-mix/setup/webpack.config.js",
+        "watch": "cross-env NODE_ENV=development node_modules/webpack/bin/webpack.js --watch --progress --hide-modules --config=node_modules/laravel-mix/setup/webpack.config.js",
+        "watch-poll": "npm run watch -- --watch-poll",
+        "hot": "cross-env NODE_ENV=development node_modules/webpack-dev-server/bin/webpack-dev-server.js --inline --hot --config=node_modules/laravel-mix/setup/webpack.config.js",
+        "prod": "npm run production",
+        "production": "cross-env NODE_ENV=production node_modules/webpack/bin/webpack.js --no-progress --hide-modules --config=node_modules/laravel-mix/setup/webpack.config.js"
+    },
+    "devDependencies": {
+        "cross-env": "^7.0",
+        "laravel-mix": "^5.0.1",
+        "laravel-mix-merge-manifest": "^0.1.2"
+    }
+}

Modules/Documentation/webpack.mix.js

@@ -0,0 +1,11 @@
+const dotenvExpand = require('dotenv-expand');
+dotenvExpand(require('dotenv').config({ path: '../../.env'/*, debug: true*/}));
+
+const mix = require('laravel-mix');
+
+mix.js(__dirname + '/Resources/assets/js/app.js', 'js/documentation.js')
+    .sass( __dirname + '/Resources/assets/sass/app.scss', 'css/documentation.css');
+
+if (mix.inProduction()) {
+    mix.version();
+}

Modules/Helpdesk/HelpdeskDatabaseSeeder.php

@@ -1,17 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Modules\Helpdesk;
-
-use Illuminate\Database\Seeder;
-use Modules\Helpdesk\Database\Seeders\HelpdeskDatabaseSeeder as DatabaseHelpdeskDatabaseSeeder;
-
-final class HelpdeskDatabaseSeeder extends Seeder
-{
-    /** @return void */
-    public function run(): void
-    {
-        $this->call(DatabaseHelpdeskDatabaseSeeder::class);
-    }
-}