README

SilverWare Application

SilverWare is a component framework built upon SilverStripe. This repository sets up a new application environment, downloading everything needed to get underway. Files are also included for easy application deployment using Deployer.

Contents

• Requirements
• Installation
• Configuration
• Issues
• To-Do
• Contribution
• Attribution
• Maintainers
• License

Requirements

• SilverStripe Framework v4
• SilverStripe CMS v4
• SilverWare
• SilverWare Theme

Installation

Installation is via Composer:

composer create-project silverware/app /path/to/app

After Composer finishes creating the project folder, SilverWare will ask a series of questions via the console to configure your installation.

Configuration

Configuration is via YAML files. Upon build, your SilverWare application uses a series of YAML fixture files to create database objects. Please browse the fixtures folder to see what is created by default.

You can inform SilverWare when it is appropriate to build objects from fixtures using configuration:

SilverWare\Core\App:
  load_fixtures: true
  load_fixtures_once: false

Using SilverStripe's environment-specific configuration, you can configure whether or not SilverWare should build from fixture files, and whether or not SilverWare should build only once, or upon each build.

These settings are particularly useful for application deployment.

Issues

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

To-Do

• Tests

Contribution

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

Attribution

• Logo icon designed by Freepik from www.flaticon.com and released under a Creative Commons BY 3.0 license.
• includes configuration for Deployer, a most excellent PHP application deployment tool by @antonmedv

Maintainers

Colin Tucker	Praxis Interactive

License

BSD-3-Clause © Praxis Interactive