A Laravel package as a backend administrating tool for Content Management and Ecommerce sites.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
tests
.gitattributes
.gitignore
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
Gruntfile.js
LICENSE.md
README.md
UPGRADE.md
bower.json
composer.json
package.json
phpunit.xml

README.md

alt text

RedminPortal by Redooor

A Laravel 5 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 both Laravel 5.0 and 5.1. See Compatibility.

Build Status

Table of Content

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

#Compatibility

Laravel RedminPortal Branch
4.2 0.1.x v0.1
5.0 0.2.x v0.2
5.1 0.3.x v0.3

Version 0.2 and 0.3 are developed in parallel. The only difference between them is the Laravel version they support. However, this may change in future.

Development for branch v0.1 has stopped. Please upgrade to v0.2 or v0.3 instead.

Important note

Version >=0.3.2 and >=0.2.2 may break your front-end due to the change in UserPricelist. Refer to UPGRADE.md for the upgrading instructions.

Version 0.3 is backward compatible to Version 0.2.

Version 0.3 and 0.2 are SOMEWHAT backward compatible to Version 0.1. Refer to UPGRADE.md.

Upgrading from v0.1?

We've included a few database migrations to upgrade the database to support v0.2/v0.3. However, use this at your own risk. The upgrade scripts were not thoroughly tested and it may not be complete. If you find something missing, please report to us using the issue ticket. We welcome any contribution too.

Refer to UPGRADE.md for the upgrading instructions.

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 install Laravel version 5.1 using the command:

composer create-project laravel/laravel myproject 5.1.*
  1. Add Redminportal to composer.json of a new Laravel application, under "require". Like this:

     "require": {
         "laravel/framework": "5.1.*",
         "redooor/redminportal": "0.3.[*|specify a version]"
     },
    

    NOTE:

    It is advisable to specify the minor version (e.g. 0.3.3) so that it's more controlled. Although we try to be as backward compatible as possible, many changes are added into each version, so it may sometimes break your front end code.

  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. 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="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

  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

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.

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

You can install Laravel version 5.1 using the command:

composer create-project laravel/laravel myproject 5.1.*
  1. Create a folder named "packages" inside the [root] folder.

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

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

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

  4. 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"
         }
     },
    
  5. 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.

  6. 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,
     ),
    
  7. 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

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

     ?> php artisan db:seed --class="RedminSeeder"
     
     Username/password: admin@admin.com/admin
    
  9. 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

  10. 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

  11. 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/
    

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

License

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

External Libraries Used

Change log

Refer to CHANGELOG.md

Upgrade Guide

Refer to UPGRADE.md