Skip to content
This repository was archived by the owner on Feb 6, 2025. It is now read-only.

Commit b6ee975

Browse files
authored
Merge pull request #555 from amplication/docs/blueprints
Docs: Blueprints Overview
2 parents 2a8cd8b + 6b6d11a commit b6ee975

File tree

5 files changed

+88
-0
lines changed

5 files changed

+88
-0
lines changed
Loading
Loading
Loading

docs/platform-features/blueprints.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
id: blueprints
3+
title: Blueprints
4+
sidebar_label: Blueprints
5+
slug: /blueprints
6+
---
7+
8+
# Blueprints
9+
10+
Blueprints are a powerful feature that lets organizations create and manage any type of resource in their development ecosystem.
11+
Whether you're building Java microservices, Python SDKs, React front-end apps, Terraform configurations, or PostgreSQL database setups, Blueprints provide a flexible way to define, generate, and manage these resources.
12+
13+
![Project-level Blueprints Tab](./assets/blueprints/blueprint.png)
14+
15+
## Why Use Blueprints
16+
17+
Blueprints enable organizations to implement their own standards, best practices, and technology choices across their development ecosystem.
18+
You can create standardized resources that match your specific requirements while maintaining consistency across teams and projects.
19+
20+
With Blueprints you can:
21+
22+
- Describe any piece of software like SDKs, deployment configs, front-end apps, and even Amplication plugins.
23+
- Create resources using your preferred technologies and frameworks
24+
- Implement organization-specific development standards
25+
- Define relationships between different parts of your system
26+
- Generate sophisticated and dynamic code based on resource relationships
27+
- Create reusable components that follow your architectural patterns
28+
29+
## How To Access Blueprints
30+
31+
Access Blueprints from your Workspace by navigating to the dedicated Blueprints tab, where you can create and manage all your blueprints.
32+
33+
1. Navigate to your workspace settings
34+
2. Select the "Blueprints" tab
35+
3. Begin creating and managing your blueprints
36+
37+
## Core Concepts
38+
39+
### Blueprint
40+
41+
A blueprint defines how a specific type of resource will be implemented in your project. It provides the foundation for generating consistent, standardized resources that align with your organization's architecture and practices. Each blueprint serves as a template that can generate multiple resources based on your requirements.
42+
43+
### Resource
44+
45+
A resource is a specific instance of a blueprint that developers use in their projects.
46+
When you create a resource from a blueprint, you get a fully configured instance that follows your organization's standards and best practices.
47+
48+
You manage blueprint resources using the same tools available for other resources in your project, like services.
49+
50+
![A resource created from a Blueprint](./assets/blueprints/resource.png)
51+
52+
### Plugins
53+
54+
Plugins define the code generation logic for your blueprints. When you create a resource from a blueprint, its associated plugins determine how the actual code and configuration files are generated.
55+
56+
Each plugin can provide specific functionality for your blueprint.
57+
For example:
58+
59+
- Custom code generation logic for your technology stack
60+
- Infrastructure and deployment configurations
61+
- Integration patterns and configurations
62+
- Organization-specific development standards
63+
64+
:::note
65+
Organizations can create private plugins to implement their specific requirements and standards. Visit the [Private Plugins](/private-plugins) page to learn more.
66+
:::
67+
68+
### Relations
69+
70+
Relations define connections between different blueprints, enabling you to model sophisticated relationships in your architecture.
71+
These relationships are available during the code generation process, allowing plugins to generate dynamic code based on connected resources and their configurations.
72+
73+
For example, you can:
74+
75+
1. Connect services to their deployment configurations
76+
2. Link services to their respective databases
77+
3. Define dependencies between different components
78+
79+
The context from these relationships enables intelligent code generation that understands how your resources interact and depend on each other.
80+
81+
![Relations between Blueprints](./assets/blueprints/relations.png)
82+
83+
## Next Steps
84+
85+
- **Create Your First Blueprint** - Learn how to create, configure, and implement your first blueprint resource
86+
- **Working with Blueprint Relations** - Discover how to connect blueprints to model your system architecture
87+
- **Blueprint Examples and Use Cases** - Explore real-world examples of how to use blueprints effectively

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ const sidebars = {
2424
"how-to/service-catalog",
2525
"how-to/live-service-templates",
2626
"platform-features/technical-debt-management",
27+
"platform-features/blueprints",
2728
{
2829
type: "doc",
2930
id: "plugins/private-plugins",

0 commit comments

Comments
 (0)