hdpero / silvershop-core

SilverShop is an e-commerce shopping cart module for the SilverStripe CMS

SilverShop Module

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.

• Website: http://silvershop.github.io
• Demo: http://demo.ss-shop.org

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.

Stay up to date / get in touch

• Planning Trello Board
• Roadmap
• Live chat on Gitter! 
• Twitter

Requirements

• SilverStripe 3.1 or higher framework & cms
• Omnipay Module + its dependencies.

See composer.json for exact set of dependencies.

Documentation

• http://demo.ss-shop.org/docs - for Developers & Users

Installation Instructions

To install silverstripe + shop into a directory called 'myshop', using composer, run the following commands:

composer create-project silverstripe/installer myshop
composer require -d myshop "silvershop/core"

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