Introduction

Shopper is an Admin Management build for Laravel 5.6+ which includes all the necessary for your online market application. This project is inspired by Orchid/Platform. Please note that this package is still under active development.

Table of Contents

1. Requirements
2. Features
3. Installation
4. Usage
5. Documentation
6. Change log
7. Testing
8. Contributing
9. Security
10. Credits
11. License

Requirements

Make sure your server meets the following requirements.

• Apache 2.2+ or nginx
• MySQL Server 5.7.8+ , Mariadb 10.3.2+ or PostgreSQL
• PHP Version 7.1.3+

Features

It packs in lots of demanding features that allows your shop to scale in no time:

• [x] Responsive Layout
• [x] Pace Loader
• [x] Admin Authentication (With Sentinel)
• [ ] Custom Admin Dashboard (E-commerce, Google Analytics)
• [x] Automatic Validation Errors
• [x] Element React
• [x] React Component
• [x] Multiple Locale, Currencies
• [x] Image Cropper
• [x] Orders Management System
• [x] Tag Management System
• [x] Discount Management System
• [x] Coupon Management System
• [x] Products, Related Products, Offers Management System
• [x] Customers Management System
• [x] Customer Cart, Wishlist, Product Reviews.
• [x] Impersonate User
• [ ] Custom attributes
• [x] Social Media Post integration (Twitter & Facebook)
• [x] Algolia Search
• [ ] Translate Message
• [ ] Custom configuration (Database download, Google Analytics)
• [x] Open Source
• [x] More to come..

Installation

Firstly, download the Laravel installer using Composer:

$ composer require mckenziearts/shopper  

Run this command to install Shopper in your project

php artisan shopper:install

This command will install shopper, publish vendor files, create shopper and storage symlinks if they don't exist in the public folder, run migrations and seeders classes.

Extend your user model using the Mckenziearts\Shopper\Plugins\Users\Models\User as Authenticatable alias:

namespace App;

use Mckenziearts\Shopper\Plugins\Users\Models\User as Authenticatable;  
  
class User extends Authenticatable  
{  
  
}

Republish Shopper's vendor files

php artisan vendor:publish --provider="Mckenziearts\Shopper\ShopperServiceProvider"
php artisan vendor:publish --all

During publishing of shopper vendors files, shopper will add some others package's configurations files to your config folder : larasap.php, scout.php, currencyConverter.php, laravellocalization.php and cartalyst.sentinel.php

If you want to create an admin user use this command:

php artisan shopper:admin

Usage

Run laravel server

php artisan serve

To view Shopper's dashboard go to:

http://localhost:8000/console

Documentation

Official documentation is available Here.

Change log

Please see the changelog for more information on what has changed recently.

Testing

$ composer test  

Contributing

Please see contributing.md for details and a todolist.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

• Arthur Monney
• Orchid Platform

License

MIT. Please see the license file for more information.