197 lines
4.4 KiB
Markdown
Executable File
197 lines
4.4 KiB
Markdown
Executable File
# Dispensary Analytics WordPress Plugin
|
|
|
|
Beautiful WordPress plugin for displaying Arizona dispensary product data with Elementor widgets and shortcodes.
|
|
|
|
**By CreationShop** - [https://creationshop.io](https://creationshop.io)
|
|
|
|
## Features
|
|
|
|
- **Elementor Widgets**: Drag-and-drop widgets for products, stores, brands, and specials
|
|
- **Beautiful Carousels**: Auto-playing product sliders with Swiper.js
|
|
- **Flexible Shortcodes**: Easy-to-use shortcodes for any page builder
|
|
- **Field Selection**: Choose which data fields to display
|
|
- **Multiple Styles**: Modern, Minimal, and Bold card designs
|
|
- **Responsive Design**: Perfect on all devices
|
|
- **High-Performance**: Lazy loading and optimized API calls
|
|
- **SEO Friendly**: Semantic HTML and proper image alt tags
|
|
|
|
## Installation
|
|
|
|
1. Upload the `dutchie-analytics` folder to `/wp-content/plugins/`
|
|
2. Activate the plugin through the 'Plugins' menu in WordPress
|
|
3. Go to Settings → Dutchie Analytics
|
|
4. Enter your API URL and authentication token
|
|
5. Test the connection
|
|
|
|
## Configuration
|
|
|
|
### API Settings
|
|
|
|
Navigate to **Settings → Dutchie Analytics**:
|
|
|
|
- **API URL**: Your Dutchie Analytics API endpoint (e.g., `https://api.dutchieanalytics.com/api`)
|
|
- **API Token**: Your JWT authentication token
|
|
|
|
## Shortcodes
|
|
|
|
### Products Grid
|
|
|
|
Display a grid of products:
|
|
|
|
```
|
|
[dutchie_products store_id="1" limit="12" columns="4"]
|
|
```
|
|
|
|
**Parameters:**
|
|
- `store_id` (required): Store ID
|
|
- `limit` (optional): Number of products (default: 12)
|
|
- `columns` (optional): Grid columns (default: 4)
|
|
- `category_id` (optional): Filter by category
|
|
- `in_stock` (optional): Show only in-stock products (default: true)
|
|
- `search` (optional): Search term
|
|
- `fields` (optional): Comma-separated fields to display
|
|
- `style` (optional): Card style - modern, minimal, bold (default: modern)
|
|
|
|
### Products Carousel
|
|
|
|
Display a sliding carousel:
|
|
|
|
```
|
|
[dutchie_carousel store_id="1" limit="20" slides_per_view="4"]
|
|
```
|
|
|
|
**Parameters:**
|
|
- `store_id` (required): Store ID
|
|
- `limit` (optional): Number of products (default: 20)
|
|
- `slides_per_view` (optional): Slides visible at once (default: 4)
|
|
- `category_id` (optional): Filter by category
|
|
- `autoplay` (optional): Enable autoplay (default: true)
|
|
- `style` (optional): Card style (default: modern)
|
|
|
|
### Stores List
|
|
|
|
Display all stores:
|
|
|
|
```
|
|
[dutchie_stores]
|
|
```
|
|
|
|
### Brands List
|
|
|
|
Display brands for a store:
|
|
|
|
```
|
|
[dutchie_brands store_id="1"]
|
|
```
|
|
|
|
### Daily Specials
|
|
|
|
Display store specials:
|
|
|
|
```
|
|
[dutchie_specials store_id="1" date="2025-01-15"]
|
|
```
|
|
|
|
**Parameters:**
|
|
- `store_id` (required): Store ID
|
|
- `date` (optional): Date for specials (default: today)
|
|
|
|
## Field Selection
|
|
|
|
Control which fields to display using the `fields` parameter:
|
|
|
|
```
|
|
[dutchie_products store_id="1" fields="id,name,price,brand,thc_percentage,in_stock"]
|
|
```
|
|
|
|
**Available Fields:**
|
|
- `id` - Product ID
|
|
- `name` - Product name
|
|
- `brand` - Brand name
|
|
- `price` - Price
|
|
- `description` - Description
|
|
- `thc_percentage` - THC %
|
|
- `cbd_percentage` - CBD %
|
|
- `weight` - Weight
|
|
- `strain_type` - Strain type
|
|
- `in_stock` - Stock status
|
|
- `image_url_full` - High-resolution image (2000x2000)
|
|
|
|
## Elementor Widgets
|
|
|
|
Find all widgets in the **Dutchie Analytics** category in Elementor:
|
|
|
|
1. **Products Grid** - Customizable product grid
|
|
2. **Products Carousel** - Auto-playing slider
|
|
3. **Stores List** - Store directory
|
|
4. **Brands List** - Brand badges
|
|
5. **Specials** - Daily deals
|
|
|
|
### Widget Controls
|
|
|
|
Each widget provides:
|
|
- **Content Tab**: Data source, filters, display options
|
|
- **Style Tab**: Colors, spacing, card styles
|
|
- **Advanced Tab**: CSS classes, animations
|
|
|
|
## Card Styles
|
|
|
|
### Modern (Default)
|
|
- Clean white cards
|
|
- Subtle shadows
|
|
- Smooth hover effects
|
|
- Blue accent colors
|
|
|
|
### Minimal
|
|
- Simple borders
|
|
- No shadows
|
|
- Hover border highlights
|
|
- Ultra-clean design
|
|
|
|
### Bold
|
|
- Gradient backgrounds
|
|
- Vibrant colors
|
|
- Large shadows
|
|
- Eye-catching design
|
|
|
|
## Customization
|
|
|
|
### Custom CSS
|
|
|
|
Add custom styles in your theme's CSS:
|
|
|
|
```css
|
|
.dutchie-product-card-modern {
|
|
border-radius: 20px;
|
|
/* Your custom styles */
|
|
}
|
|
```
|
|
|
|
### Hooks and Filters
|
|
|
|
Coming soon: WordPress hooks for advanced customization.
|
|
|
|
## Requirements
|
|
|
|
- WordPress 5.0 or higher
|
|
- PHP 7.4 or higher
|
|
- Elementor (optional, for widgets)
|
|
|
|
## Support
|
|
|
|
For support, visit: [https://dutchieanalytics.com/support](https://dutchieanalytics.com/support)
|
|
|
|
## Changelog
|
|
|
|
### 1.0.0
|
|
- Initial release
|
|
- Elementor widgets
|
|
- Shortcodes
|
|
- Field selection
|
|
- Multiple card styles
|
|
- Carousel support
|
|
|
|
## License
|
|
|
|
GPL v2 or later
|