redooor/redminportal

RedminPortal by Redooor

A Laravel package as a backend administrating tool for Content Management and Ecommerce sites. Gives you ability to add, edit and remove category, product, promotions and many more. Provides User Interface for administrating users and groups.

RedminPortal currently supports Laravel 13. See Compatibility.

Table of Content

1. Compatibility
2. Models and Features
3. Installation guide for Users
4. Showing pages on your own frontend
5. Installation guide for Contributors
6. Testing
7. Versioning
8. Contributing
9. Creator
10. License
11. External Libraries Used
12. Change log
13. Upgrade Guide

Compatibility

The focus of the development will be on branch v2, which supports Laravel 13.

Development for branch v0.1, v0.2, v0.3, and v0.58 has stopped. Please upgrade to v2.

Upgrading

Refer to UPGRADE.md for upgrading instructions from any previous version.

Models and Features

User Management

• User
• Group
• Mailinglist

Content Management

• Announcement
• Page
• Portfolio
• Post
• Promotion

Online Store (Physical Products)

• Bundle
• Category
• Coupon
• Order
• Product (now supports variations)

Membership Subscription (Digital Products)

• Bundle
• Category
• Coupon
• Media
• Membership
• Module
• ModuleMediaMembership
• Order
• Purchase (deprecated, replaced by Order)
• Pricelist

Morphs

• Image
• Revision (new! Now changes to Orders are tracked)
• Tag
• Translation

Traits

• Permissible
• Revisionable

Classes

• File
• Volume
• Weight
• Imagine
• Redminportal (use as alias in blade template)

Helpers

• RHelper
• RImage (replaced by Classes/Imagine, retained for backward compatibility)

Facades

• Redminportal

Downloadable Reports

1. Downloadable CSV reports for Purchases and Mailinglist.

Translation options

There is an translation option in Category, Module, Media, Product, Promotion and Portfolio.

You can add more languages in the translation config file at path

vendor\redooor\redminportal\src\config\translation.php

or if you have published it to your root

root\config\packages\redooor\redminportal\translation.php

To use it, get the model's translations and use json_decode to convert content into an object, like this:

foreach ($product->translations as $translation) {
    $lang = $translation->lang;
    $translated = json_decode($translation->content);
    var_dump($translated->name, $translated->short_description, $translated->long_description);
}

Installation guide for Users

You can create a new Laravel 13 application using the command:

composer create-project laravel/laravel myproject

1. Add Redminportal to composer.json of a new Laravel application, under "require". Like this:

    "require": {
        "laravel/framework": "^13.0",
        "redooor/redminportal": "^2.0"
    },
   

2. Then run php composer update [--prefer-dist] in a terminal.

   Use --prefer-dist to include only essential files (i.e. exclude tests).

3. Now, edit your [root]\config\app.php providers and alias array like this:

    'providers' => array(
        Illuminate\Foundation\Providers\ArtisanServiceProvider::class,
        ... omitted ...
   
        // Add this line
        Redooor\Redminportal\RedminportalServiceProvider::class,
    ),
   

4. Then run php composer dump-autoload in a terminal.

5. Important: remove Laravel's default users migration first.

   Redminportal creates its own users table (with extra columns such as first_name, last_name, permissions and activated). Its migration is skipped when a users table already exists, so if Laravel's default one has been migrated, the later seeding step fails with table users has no column named first_name.

   In a new Laravel application, delete database/migrations/0001_01_01_000000_create_users_table.php before running any migration. If you have already migrated, delete the file and run php artisan migrate:fresh (this drops all tables).

   That default migration also creates the sessions table. If you keep SESSION_DRIVER=database, add the sessions table back yourself, or set SESSION_DRIVER=file in your .env.

   If your application already has its own users table, Redminportal will not alter it. You must add the missing columns yourself, or use a separate database for Redminportal.

   Then run the following commands in a terminal to perform database migration for Redminportal:

    php artisan vendor:publish --provider="Redooor\Redminportal\RedminportalServiceProvider" --tag="migrations" [--force]
   
    php artisan migrate --path=/database/migrations/vendor/redooor/redminportal
   

   CAUTION: using --force will overwrite existing files

6. Run the following in a terminal to seed the database with initial admin username and password:

    php artisan db:seed --class="Database\Seeders\RedminSeeder"
   
    Username/password: admin@admin.com/admin
   

7. Publish package assets by running this in a terminal:

    php artisan vendor:publish --provider="Redooor\Redminportal\RedminportalServiceProvider" --tag="public" [--force]
   

   CAUTION: using --force will overwrite existing files

8. Publish package config by running this in a terminal:

    php artisan vendor:publish --provider="Redooor\Redminportal\RedminportalServiceProvider" --tag="config" [--force]
   

   CAUTION: using --force will overwrite existing files

   IMPORTANT:

   The package will append neccesary guards and providers to your auth config. If you've added a guard with the same name as redminguard and provider as redminprovider, they'll be replaced by the package's setting.

   If you're going to use your own auth config but would like to use Redminportal for authentication, you need to add the a guard in your auth config as below:

   'defaults' => [
       'guard' => 'web', // or it could be 'redminguard'
       'passwords' => 'redminpasswords',
   ],
   

   'guards' => [
       'redminguard' => [
           'driver' => 'session',
           'provider' => 'redminprovider',
       ],
       'web' => [
           'driver' => 'session',
           'provider' => 'redminprovider',
       ],
   ],
   

   'providers' => [
       'redminprovider' => [
           'driver' => 'eloquent',
           'model' => Redooor\Redminportal\App\Models\User::class,
       ],
   ],
   

   'passwords' => [
       'redminpasswords' => [
           'provider' => 'redminprovider',
           'table' => 'password_reset_tokens',
           'expire' => 60,
       ],
   ],
   

9. Optional: Publish package views by running this in a terminal:

   Only do this if you want to modify Redminportal views without editing the source code.

    php artisan vendor:publish --provider="Redooor\Redminportal\RedminportalServiceProvider" --tag="views" [--force]
   

   CAUTION: using --force will overwrite existing files

Showing pages on your own frontend

RedminPortal is an admin dashboard only. It stores your content, and your Laravel application decides how to show it. This example shows pages created in Admin > Pages at the site root, so a page with slug about appears at /about (not /page/about).

If you would rather not build this yourself, the optional RedminStore package does exactly this out of the box.

1. In the admin, create a page: set a Title, Content and Slug (for example about), and leave Private unchecked. Private pages should never be shown publicly.

2. Create a controller, app/Http/Controllers/PageController.php:

    <?php
   
    namespace App\Http\Controllers;
   
    use Illuminate\Http\Request;
    use Redooor\Redminportal\App\Models\Page;
   
    class PageController extends Controller
    {
        public function show(Request $request)
        {
            $slug = trim($request->path(), '/');
   
            // Only single-segment URLs such as /about; anything else is a normal 404.
            abort_if(str_contains($slug, '/'), 404);
   
            $page = Page::where('slug', $slug)
                ->where('private', false)   // never show pages marked Private in the admin
                ->firstOrFail();
   
            return view('page', ['page' => $page]);
        }
    }
   

3. Create the view, resources/views/page.blade.php. Use your own layout here:

    <h1>{{ $page->title }}</h1>
   
    {{-- Page content is HTML written by trusted admins in RedminPortal's editor. --}}
    {!! $page->content !!}
   

4. Register a fallback route at the end of routes/web.php:

    use App\Http\Controllers\PageController;
   
    Route::fallback([PageController::class, 'show']);
   

A fallback route runs only when no other route matches, so it never takes over your own routes or RedminPortal's /admin and /login, whatever order they are registered in. A page with the same slug as a real route (for example login) is therefore never shown. Unknown URLs return your normal 404 page. Use a controller rather than a closure so that php artisan route:cache keeps working.

Notes:

• Slugs are stored with spaces replaced by underscores. Use letters, numbers, - and _ in slugs.
• $page->content is raw HTML, so only print it unescaped ({!! !!}) if only trusted admins can edit pages.
• A page also has category, tags, images and translations relationships, for example $page->images and $page->tags.
• Posts work the same way: use the Post model with where('private', false), and give them a prefix such as /blog/{slug} to avoid clashing with page slugs.

Installation guide for Contributors

It is recommended that contributors use Laravel Homestead for development because it will provide the same development environment for all of us. Read more about Laravel Homestead here.

For Mac users, you may want to try out Laravel Herd.

1. Install Laravel 13 using this guide. We'll call this the [root].

You can create a new Laravel 13 application using the command:

composer create-project laravel/laravel myproject

2. Create a folder named "packages" inside the [root] folder.

3. Clone the Redooor\Redminportal repository into [root]\packages\redooor\redminportal folder.

4. Open a terminal, cd to [root]\packages\redooor\redminportal folder then run:

   composer update --prefer-dist -vvv --profile

5. Then add Redooor\Redminportal source to [root]'s composer.json under "autoload" like this:

    "autoload": {
        "classmap": [
            "database"
        ],
        "psr-4": {
            "App\\": "app/",
            "Redooor\\Redminportal\\": "packages/redooor/redminportal/src"
        }
    },
   

6. Then cd to [root]'s folder and run:

   composer update --prefer-dist -vvv --profile --no-dev

   NOTE: the [root]'s phpunit dependency will clash with the package's phpunit. "--no-dev" ensures that it is not installed on [root]. You can also choose to remove phpunit from require inside the [root]'s composer.json.

7. Now, edit your [root]\config\app.php providers and alias array like this:

    'providers' => array(
        Illuminate\Foundation\Providers\ArtisanServiceProvider::class,
        ... omitted ...
   
        // Add this line
        Redooor\Redminportal\RedminportalServiceProvider::class,
    ),
   

8. Run the following commands in a terminal to perform database migration for Redminportal inside the [root] folder:

    php artisan vendor:publish --provider="Redooor\Redminportal\RedminportalServiceProvider" --tag="migrations" [--force]
   
    php artisan migrate --path=/database/migrations/vendor/redooor/redminportal
   

   CAUTION: using --force will overwrite existing files

9. Run the following in a terminal to seed the database with initial admin username and password:

    php artisan db:seed --class="Database\Seeders\RedminSeeder"
   
    Username/password: admin@admin.com/admin
   

10. Publish package assets by running this in a terminal:

    php artisan vendor:publish --provider="Redooor\Redminportal\RedminportalServiceProvider" --tag="public" [--force]
    

    CAUTION: using --force will overwrite existing files

11. Publish package config by running this in a terminal:

    php artisan vendor:publish --provider="Redooor\Redminportal\RedminportalServiceProvider" --tag="config" [--force]
    

    CAUTION: using --force will overwrite existing files

12. Optional: Publish package views by running this in a terminal:

    Only do this if you want to modify Redminportal views without editing the source code.

    php artisan vendor:publish --provider="Redooor\Redminportal\RedminportalServiceProvider" --tag="views" [--force]
    

    CAUTION: using --force will overwrite existing files

Install Grunt and Bower dependencies

1. You need to have nodejs installed
2. cd to packages/redooor/redminportal
3. Run npm install
4. Run bower install
5. To build all assets, run grunt
6. To compile just the less css, run grunt less-compile

Testing

• In packages\redooor\redminportal folder, run

    composer update --prefer-dist -vvv --profile
  
    vendor/bin/phpunit
  

  NOTE: If you run out of memory while running the full tests, try running the tests by sub-folders.

    vendor/bin/phpunit tests/models/
  
    vendor/bin/phpunit tests/controllers/
  
    vendor/bin/phpunit tests/relationships/
  
    ./vendor/bin/phpunit --testsuite "suite1","suite2"
  
    ./vendor/bin/phpunit --testsuite "suite3","suite4"
  

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Redooor RedminPortal will adhere to the Semantic Versioning guidelines whenever possible.

Contributing

Thank you for considering contributing to RedminPortal. Before any submission, please spend some time reading through the CONTRIBUTING.md document.

Creator

Andrews Ang

• http://github.com/kongnir

License

RedminPortal is open-sourced software licensed under the MIT license.

External Libraries Used

• Bootstrap v3
• Font Awesome 4.4.0 by @davegandy
• jQuery v2
• jQuery UI v1
• illuminate/html
• maatwebsite/excel
• Imagine
• Jasny Bootstrap
• Plupload
• getID3

Change log

Refer to CHANGELOG.md

Upgrade Guide

Refer to UPGRADE.md