praxisnetau / silverware-theme

The default theme for a SilverWare application

SilverWare Theme

The default theme for a SilverWare application, based upon:

• Webpack v3 (includes dev server)
• Bootstrap v4 (now supports v4.0.0 final)
• SilverStripe v4
• Font Awesome v4.7.0
• Modernizr

Contents

• Requirements
• Installation
• Usage
• Issues
• Contribution
• Attribution
• Maintainers
• License

Requirements

• SilverWare

Installation

Installation is via Composer:

$ composer require silverware/theme

You will also need to use Yarn (or NPM) to install the theme dependencies:

$ cd themes/silverware-theme
$ yarn install

Once your theme dependencies are installed, execute the following to start the webpack development server:

$ yarn start

The theme should now compile with hot module reloading enabled, allowing the browser to automatically reload and update your styles as you make changes to the theme Sass.

To prepare your theme for production, execute the following:

$ yarn build

Usage

To use this theme with your SilverWare application, you will need to configure SSViewer via YAML:

SilverStripe\View\SSViewer:
  themes:
    - 'silverware-theme'
    - '$default'

Issues

Please use the GitHub issue tracker for bug reports and feature requests.

Contribution

Your contributions are gladly welcomed to help make this project better. Please see contributing for more information.

Attribution

• Makes use of Font Awesome by Dave Gandy.
• Makes use of Bootstrap by the Bootstrap Authors and Twitter, Inc.
• Makes use of webpack and webpack dev server by Tobias Koppers, Kees Kluskens, and many more.

Maintainers

Colin Tucker	Praxis Interactive

License

BSD-3-Clause © Praxis Interactive