Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add plugin for blueprint plugin template #412

Merged
merged 1 commit into from
Jan 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions blueprint-plugins/blueprint-plugin-template/.amplicationrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"settings": {
"author": "Blueprint Plugin Author Placeholder",
"license": "Apache-2.0",
"copyPluginSettings": {
"param1": "param1-value",
"param2": "param2-value",
"array": ["array-value1", "array-value2"]
}
}
}
8 changes: 8 additions & 0 deletions blueprint-plugins/blueprint-plugin-template/.eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
node_modules
**/node_modules
dist
**/src/models.ts
**/*.stories.tsx
coverage
**/*.template.ts
src/static
31 changes: 31 additions & 0 deletions blueprint-plugins/blueprint-plugin-template/.eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"env": {
"node": true,
"es2021": true
},
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/recommended",
"plugin:prettier/recommended"
],
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": 2021,
"sourceType": "module"
},
"plugins": ["@typescript-eslint", "prettier"],
"rules": {
"@typescript-eslint/no-unused-vars": [
"warn",
{ "argsIgnorePattern": "^_", "varsIgnorePattern": "^_" }
],
"@typescript-eslint/no-explicit-any": "warn",
"@typescript-eslint/explicit-function-return-type": [
"warn",
{ "allowExpressions": true }
],
"no-console": "warn",
"prettier/prettier": ["error"]
},
"ignorePatterns": ["node_modules/", "dist/", "build/", ".eslintrc.js"]
}
62 changes: 62 additions & 0 deletions blueprint-plugins/blueprint-plugin-template/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# See http://help.github.com/ignore-files/ for more about ignoring files.

# compiled output

tmp
/out-tsc

# dependencies
node_modules
**/node_modules/

# IDEs and editors
/.idea
.project
.classpath
.c9/
*.launch
.settings/
*.sublime-workspace

# IDE - VSCode
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
*.code-workspace

# Local History for Visual Studio Code
.history/

# Common credential files
**/credentials.json
**/client_secrets.json
**/client_secret.json
*.dat
*.httr-oauth*

# Terraform development
**/.terraform.lock.hcl
**/.terraform
**/terraform.tfstate
**/terraform.tfstate.backup

# misc
/.sass-cache
/connect.lock
**/coverage/
/libpeerconnection.log
npm-debug.log
yarn-error.log
testem.log
/typings


# System Files
.DS_Store
Thumbs.db

.nx/cache

.env.local
2 changes: 2 additions & 0 deletions blueprint-plugins/blueprint-plugin-template/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.prettierignore
.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
dist
5 changes: 5 additions & 0 deletions blueprint-plugins/blueprint-plugin-template/.prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$schema": "http://json.schemastore.org/prettierrc",
"singleQuote": false,
"trailingComma": "all"
}
32 changes: 32 additions & 0 deletions blueprint-plugins/blueprint-plugin-template/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Amplication Blueprint Plugin Template

## Overview

This is a plugin for creating a template for creating Amplication Blueprint Plugins. It provides a basic structure and necessary files to help you get started with developing your own plugins.

Although you can clone this plugin as a starting point to create a new plugin, the main purpose of this plugin is to be used from within Amplication with a blueprint to be able to create plugin templates from the Amplication UI.

## Getting Started

To get started with creating your own Amplication Blueprint Plugin, follow these steps:

1. **Go to Amplication**: Open your web browser and navigate to [Amplication](https://app.amplication.com).

2. **Create a Blueprint**:

- Log in to your Amplication account.
- Go to the "Blueprints" section in the "Settings" tab in the workspace.
- Create a new blueprint and call it "Amplication Plugin".

3. **Create a Plugin**:

- Go to the "Plugin Repository" section in the "Platform" settings.
- Create a new plugin and connect it to this code repository.

## Creating a new Plugin

When ever you want to create a new plugin, follow the common practice to create a resource in Amplication, using the new "Amplication Plugin" blueprint.

## License

This plugin is licensed under the MIT License.
Loading
Loading