Merge pull request #12 from Simpletine/develop

Release v1.2.0-alpha

Author: Simpletine

.gitignore

@@ -126,3 +126,5 @@ nb-configuration.xml
 /phpunit*.xml
 /.phpunit.*.cache
 
+# SimpleTine
+!public/assets/*

.php-cs-fixer.dist.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) 2021 CodeIgniter Foundation <admin@codeigniter.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+use CodeIgniter\CodingStandard\CodeIgniter4;
+use Nexus\CsConfig\Factory;
+use PhpCsFixer\Finder;
+
+$finder = Finder::create()
+    ->files()
+    ->in([__DIR__])
+    ->exclude(['build'])
+    ->append([__FILE__]);
+
+$overrides = [
+    'declare_strict_types' => true,
+];
+
+$options = [
+    'finder'    => $finder,
+    'cacheFile' => 'build/.php-cs-fixer.cache',
+];
+
+return Factory::create(new CodeIgniter4(), $overrides, $options)->forLibrary(
+    'CodeIgniter 4 framework',
+    'CodeIgniter Foundation',
+    'admin@codeigniter.com',
+    2021
+);

CHANGELOG.md

@@ -1,11 +1,29 @@
 # Change Log
 
+## v1.2.0-alpha - 2024-07-16
+
+### Fixed
+- Fix: Template file not found: `controller.new.tpl.php`
+
+### Changes
+
+- Update README.md and CHANGELOG.md
+
+### Features
+
+- Implement CodeIgniter Shield
+- Implement AdminLTE
+- Coding Standard
+
+
 ## v1.1.0 - 2024-07-13
 
 ### Changes
+
 - Renamed command `make:module` to `module:create` for better consistency
 
 ### Features
+
 - Added module `config` folder for management of routes within configs ([#5](https://github.com/Simpletine/CodeIgniter4-HMVC/issues/5))
 - `module:controller`: Create a controller in a specified module ([#4](https://github.com/Simpletine/CodeIgniter4-HMVC/issues/4))
 - `module:model`: Create a model in a specified module ([#3](https://github.com/Simpletine/CodeIgniter4-HMVC/issues/3))

LICENSE

@@ -1,7 +1,5 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2019 British Columbia Institute of Technology
-Copyright (c) 2019-2024 CodeIgniter Foundation
 Copyright (c) 2022-2024 SimpleTine
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

README.md

@@ -1,58 +1,103 @@
-# Codeigniter 4 HMVC 
-
 [![Official Website](https://img.shields.io/badge/Official_Website-Visit-yellow)](https://simpletine.com)   [![YouTube Channel](https://img.shields.io/badge/YouTube_Channel-Subscribe-FF0000)](https://www.youtube.com/channel/UCRuDf31rPyyC2PUbsMG0vZw) 
 
-### Prerequisites
+# Codeigniter 4 HMVC 
+This repository features a modular HMVC (Hierarchical Model-View-Controller) architecture for CodeIgniter 4, integrated with the official authentication system, CodeIgniter 4 Shield. It also includes a comprehensive Admin Dashboard built with AdminLTE, providing a robust foundation for scalable and secure web applications.
+
+## Prerequisites
 1. PHP 7.4 or above
 2. Composer required
 2. CodeIgniter 4.4.8
 
-### Installation Guide
+# Installation Guide
 
 Clone project to your project root folder
 ```bash
-composer create-project simpletine/codeigniter4-hmvc ci4_hmvc --stability=dev
+git clone https://github.com/Simpletine/CodeIgniter4-HMVC.git ci4_hmvc
 ```
+
 Or
+
 ```bash
-git clone https://github.com/Simpletine/CodeIgniter4-HMVC.git ci4_hmvc
+composer create-project simpletine/codeigniter4-hmvc ci4_hmvc --stability=dev
+```
+
+Copy `env` file
+```bash
+cp env .env
 ```
-Then
+
+Run the app, using different port, add options `--port=9000`
 ```bash
-cd ci4_hmvc
-``` 
+php spark serve
+```
+
+## Database Configuration
+Create database & sessions migration
 
-Copy some require file to root folder (Upgrading to v4.4.8)
+```bash
+php spark db:create ci4_shield
+```
+
+```bash
+php spark make:migration --session
+php spark shield:setup
+```
+
+
+## Default Auth
+
+```bash
+email: super@admin.com
+password: password
+```
+
+## Create User
+Use command line to create a new user
+```bash
+php spark shield:user create
+```
+
+## Notice
+If you are using old versions, after composer update, you need to update the `index.php` and `spark` file to root folder (Upgrading to v4.4.8)
 ```bash
 composer update
 cp vendor/codeigniter4/framework/public/index.php public/index.php
 cp vendor/codeigniter4/framework/spark spark
 ```
 
-Copy `env` file
+# Module Commands
+Commands available and funcationality
+
+## General
+Create a new module named `Blogs`
 ```bash
-cp env .env
+php spark module:create Blogs 
 ```
 
-Run the app, using different port, add options `--port=9000`
+Clone a existing module of `Blogs` and renamed to `Items`
 ```bash
-php spark serve
+php spark module:copy Blogs Items 
 ```
 
+Create a controller to module `Blogs` named `Categories.php`
+```bash
+php spark module:controller Blogs Categories 
+```
 
----
-## Module Commands
+Create a model to module `Blogs` named `Categories.php`
 ```bash
-php spark make:module [module] 
+php spark module:model Blogs Categories 
 ```
 
-### Example
-Create a blog module
+## Admin
+Additional options for the commands
+
+Create a new controller and view to `Admin` module with `AdminLTE`
 ```bash
-php spark make:module blogs
+php spark module:controller Admin Users --admin 
 ```
 
-###  Result Directory
+##  Modules Directory
     App 
     ├── Modules      
     │   └── Blogs
@@ -67,23 +112,33 @@ php spark make:module blogs
     └── ...  
 
 ### Route Group
-After generate `Blogs` Module, the routes group for the module at `Modules\Config\Routes.php`
+Add new subroutes to `blogs` named `new` with method name
+
+```php
+$routes->get('new', 'Blogs::new');
+```
+
+Sample of routes group after new subroutes
 ```php
 $routes->group(
     'blogs', ['namespace' => '\Modules\Blogs\Controllers'], function ($routes) {
         $routes->get('/', 'Blogs::index');
+        $routes->get('new', 'Blogs::new');
     }
 );
 ```
 
-## PSR4
+# PHPCS
+
+Default instance of containing all rules applicable for the CodeIgniter organization
+```bash
+composer run fix
+```
+
+# PSR4
 At `App/Config/Autoload.php`, you can configure your custom namespace:
 ```php
 public $psr4 = [
-    // Sample
-    "$module" => APPPATH . "$module",
-
-    // Base on Example above
     "Blogs" => APPPATH . "Modules/Blogs", // Example 
     // ...
 ];