Provides an ecommerce product catalog, shopping cart, and order management system

3.0.0-alpha2 2018-02-15 15:49 UTC

README

The SilverShop module aims to provide developers with a framework for building, and customising ecommerce-based projects. It includes facilities for customers to browse products and place orders, and for administrators to manage products and orders. We've put a strong focus on testing, and thanks to TravisCI, you can see the build status of this project, running on MySQL, SQLite, Postgres, as well as a few different versions of PHP.

Latest Stable Version Latest Unstable Version Build Status Code Coverage Scrutinizer Quality Score Total Downloads

Your contributions, and feedback are welcomed and appreciated. There are many ways you can contribute to this project. A tremendous thanks to everyone that has already contributed.

Requirements

See composer.json for exact set of dependencies.

For a SilverStripe 3.x compatible version, please use a 2.x release.

Stay up to date / get in touch

Documentation

Installation Instructions

To install SilverShop using composer, run the following command:

composer require silvershop/core ^3@dev

Build Tasks

There are a few useful tasks that can be run via a url to help you test:

  • {yoursite.com}/dev/tasks/PopulateShopTask - will create cart, checkout, account, category and product pages
  • {yoursite.com}/dev/tasks/PopulateCartTask - will add products to the cart, and navitate you to the checkout

Configuration

You can view various configuration options in the 'example_config.yml' file.

Core Features

  • Product Catalog - Products extend Page, and can be browsed within Product Category pages.
  • Cart Page - For viewing and updating your cart.
  • Checkout - Gather delivery/billing details and anything specific to the order. Can be single-page or multi-step.
  • Online Payments - Via the omnipay module.
  • Administration - Manage the catalog and orders in the CMS.

Futher functionality is provided by add-on submodules.

Add-on Sub Modules

Don't reinvent the wheel! Get additional pre-built functionality with sub modules. All additional functional will be tagged on packgist or github.

The code for the shop demo site is available here:

https://github.com/burnbright/silverstripe-shop-demo