Get Started
Lifecycle & Coding Details
Developing a Plugin
Guides & Tutorials
AST Libraries
Blueprint Plugin Events
Node.js Plugin Events
- Create Server
- Create Server Docker Compose
- Create Server Docker Compose Dev
- Create Server Dot Env
- Create Server Auth
- Create Package Json
- Create Entity Service
- Create Entity Service Base
- Create Entity Controller
- Create Entity Controller Base
- Create Entity Resolver
- Create Entity Resolver Base
- Create Message Broker Service
- Create Message Broker Service Base
- Create Message Broker NestJS Module
- Create Message Broker Client Options Factory
- Create Message Broker Topics Enum
- Create Prisma Schema
.NET Plugin Events
- Create Server
- Create Server Appsettings
- Create Server Auth
- Create Program File
- Create Server Csproj
- Create Server Docker Compose
- Create Server Git Ignore
- Create Entity Model
- Create Resource Db Context File
- Create Message Broker
- Create Message Broker Client Options Factory
- Create Message Broker Service
- Create Entity Controller
- Create Entity Controller Base
- Create DTOs
- Create Entity Extensions
- Create Entity Interface
- Create Entity Service
- Create Entity Service Base
- Create Seed Development Data File
- Load Static Files
Configure Your Plugin
Customize your plugins to align with team standards and enhance developer experience. Tailor display, code generators, and versions for optimal use within your organization.
After you’ve added your plugin to the plugin repository in Amplication, you have access to a few configuration options. They are key to making your plugin easily discoverable in the UI, relevant to your projects, and smoothly integrated into your existing workflows.
Configuration Options
The following options allow you to configure how your plugin appears and functions within Amplication:
By default, the display name of your plugin is the same as its Plugin ID. However, you can customize this to make it more user-friendly and descriptive within the Amplication UI.
A clear and concise display name helps your teammates quickly understand the plugin’s purpose and functionality when browsing available plugins.
Choose a display name that is intuitive and easily understood by your team. For example, instead of a generic ID like my-auth-plugin, consider a display name like “Organization Standard Authentication”.
Amplication provides a library of icons and color palettes to visually represent your plugins. Choosing a custom icon and color makes your plugins stand out in the UI and enhances visual recognition.
This visual distinction is especially helpful when you have multiple plugins in your organization’s repository. A recognizable icon can significantly speed up plugin discovery and selection.
The Code Generator option determines which code generator the plugin is built for (e.g., .NET, Node.js, Blueprints). This option dictates:
- Plugin Compatibility: A plugin built for Node.js will only be available for Node.js based resources.
- Plugin Events: Each code generator exposes a specific set of .
To learn more about available plugin events, see the Plugin Events reference documentation for your selected code generator.
The description appears in the Amplication UI and provides valuable context to your developers. A well-written description should clearly explain:
- The plugin’s purpose and functionality
- The problems it solves or the enhancements it provides
- Any specific use cases or requirements
The Versions section allows you to manage different iterations of your plugin. This is crucial for:
- Publishing new versions as you improve your plugin
- Controlled updates via Pull Requests when new versions are available
- Maintaining consistency across all services in your organization
To learn more about plugin versioning, see the Publish a Plugin guide.
When enabled, Dev Version allows Amplication to pull the plugin code directly from the base branch (e.g., main, develop) defined in your Git settings.
This option streamlines plugin testing during development by avoiding the formal plugin publishing process, allowing for quicker iterations and experimentation.
To learn more about testing plugins during development, see the Test a Plugin guide.
Was this page helpful?