Skip to content

bsh-devsolutions/bshengine.plugin.template

Repository files navigation

BSH Plugin Template

A template repository for creating new BSH plugins.

What is this?

This template provides a standardized structure for BSH plugins, including:

  • BshConfigurations - Engine configuration files
  • BshEmailTemplates - Email template definitions
  • BshEntities - Entity definitions and schemas
  • BshSchemas - Schema definitions
  • BshTypes - Type definitions
  • BshRoles - Role definitions
  • BshPolicies - Policy configurations
  • BshTriggers - Trigger configurations

How to use this template

  1. Click the "Use this template" button on GitHub to create a new repository from this template
  2. Clone your new repository
  3. Update bshplugin.json with your plugin details:
    • Replace <plugin id> with your unique plugin identifier
    • Replace <plugin name> with your plugin name
    • Replace <plugin description> with a description
    • Replace <plugin author> with your name
    • Update the image field if needed
  4. Customize the sample files in each directory according to your needs
  5. Remove or modify the sample files as needed

Project Structure

.
├── bshplugin.json          # Main plugin configuration
├── BshConfigurations/      # Engine Configuration files
├── BshEmailTemplates/      # Email templates
├── BshEntities/            # Entity definitions
├── BshPolicies/            # Policy configurations
├── BshRoles/               # Role definitions
├── BshSchemas/             # Schema definitions
├── BshTriggers/            # Trigger configurations
└── BshTypes/               # Type definitions

Each directory contains:

  • __manifest__.json - Manifest file defining the directory's target and dependencies
  • Sample files - Example configurations to guide your setup

License

MIT

About

A base template for bsh engin plugins

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published