# Brandy Starter Sites

Extra starter site templates for the [Brandy WordPress Theme](https://yaycommerce.com/).

**Version:** 1.5
**Author:** [YayCommerce](https://yaycommerce.com/)
**License:** GPLv3 or later
**Requires:** PHP 7.0+, WordPress 5.2+, Brandy Theme

## Overview

Brandy Starter Sites provides 17 professionally designed ecommerce store templates, enabling rapid WooCommerce store deployment with pre-configured:

- Block patterns (hero banners, product collections, testimonials)
- Theme styles (colors, typography, layouts)
- Sample products and demo content
- WooCommerce integrations

## Available Templates

| Template | Description |
|----------|-------------|
| Fashion | Modern fashion store with size charts & swatches |
| EBook | Digital products with premium tags |
| Jewelry Light/Dark | Luxury jewelry with light/dark variants |
| Halloween V1/V2 | Seasonal Halloween stores |
| Christmas V1 | Holiday-themed seasonal store |
| Hair V1/V2 | Hair care products |
| Plants | Botanical/plant store |
| Shoes | Footwear ecommerce |
| BookV1 | Book/publishing store |
| Cosmetic | Beauty products |
| Houseware | Home goods |
| Pet | Pet supplies |
| Skateboards | Lifestyle products |
| Tech | Technology marketplace |

## Requirements

- **WordPress:** 5.2 or higher
- **PHP:** 7.0 or higher
- **Brandy Theme:** Must be installed and active
- **WooCommerce:** Recommended for ecommerce features

## Installation

1. Ensure Brandy theme is installed and activated
2. Upload `brandy-sites` to `/wp-content/plugins/`
3. Activate via WordPress admin > Plugins
4. Navigate to Appearance > Starter Sites

## Development

### Setup

```bash
# Install dependencies
composer install

# Install dev tools
cd tools && composer install
```

### Code Standards

```bash
# Check standards
./tools/vendor/bin/phpcs

# Auto-fix
./tools/vendor/bin/phpcbf
```

### Release

```bash
./run.sh release
```

## Project Structure

```
brandy-sites/
├── brandy-sites.php      # Plugin entry point
├── inc/                  # PHP source code
│   ├── PluginInitialize.php
│   ├── SitesLoader.php   # Registers all 17 templates
│   ├── Fallback.php
│   └── Sites/            # 17 niche directories
├── styles/               # WordPress theme.json configs
├── assets/               # Fonts and images
├── templates/            # Admin notice templates
└── docs/                 # Developer documentation
```

## Documentation

Detailed documentation available in [`docs/`](./docs/):

- [Project Overview](./docs/project-overview-pdr.md) - Vision and requirements
- [Codebase Summary](./docs/codebase-summary.md) - Code structure
- [Code Standards](./docs/code-standards.md) - Coding guidelines
- [System Architecture](./docs/system-architecture.md) - Technical architecture

## Adding a New Template

1. Create directory: `inc/Sites/YourNiche/`
2. Create `NicheSetup.php` extending `AbstractNicheSetup`
3. Add patterns in `patterns/` subdirectory
4. Create `styles/your-niche.json` for theme settings
5. Register in `SitesLoader.php`

## Support

- Plugin URI: https://yaycommerce.com/
- Issues: Contact YayCommerce support

## License

GPLv3 or later - see [LICENSE](https://www.gnu.org/licenses/gpl-3.0.html)

---

Copyright (c) YayCommerce