Skip to content

template-contribution.md

Latest commit

 

History

History
191 lines (137 loc) · 5.68 KB

template-contribution.md

File metadata and controls

191 lines (137 loc) · 5.68 KB

Template Contribution Guide

Quickstart · Main Contributing Guide

A template is the simplest contribution type — a single exported Lamatic flow. Templates don't include a web application or multi-flow orchestration. They are the flow files exactly as exported from Lamatic Studio, ready for users to import into their own workspace.

If you've built a useful flow and want to share it with the community, this is the fastest way to contribute.

Reference implementation: templates/get-started/

Prerequisites

Before following this guide, complete Steps 1–3 in the main Contributing Guide:

  1. Fork and clone the repository
  2. Build your flow in Lamatic Studio
  3. Export your flow files

Templates are flow-only — no Node.js, npm, or Vercel setup is needed.

Step 1: Create Your Template Folder

1.1 Folder Structure

A template is exactly the 4 files you get from a Lamatic flow export:

templates/<template-name>/
├── config.json    # Flow graph (nodes + edges)
├── inputs.json    # Node input schemas
├── meta.json      # Flow metadata (name, description, tags, author)
└── README.md      # Flow documentation

Use kebab-case for the folder name (e.g., blog-writer-agent, recipe-generation, slack-ask-bot).

1.2 Create the Folder and Copy Files

# Create your template folder
mkdir -p templates/<template-name>

# Copy your exported flow files
cp -R ~/Downloads/exported-flow/* templates/<template-name>/

Step 2: Verify Your Exported Files

After copying, verify each file is present and valid.

2.1 config.json — Flow Graph

This is a flow-level config (not a kit-level config). It contains the workflow graph with nodes and edges:

{
  "nodes": [
    {
      "id": "triggerNode_1",
      "type": "triggerNode",
      "data": { "..." },
      "position": { "x": 0, "y": 0 }
    },
    {
      "id": "LLMNode_398",
      "type": "dynamicNode",
      "data": { "..." }
    }
  ],
  "edges": [
    {
      "id": "triggerNode_1-LLMNode_398",
      "source": "triggerNode_1",
      "target": "LLMNode_398"
    }
  ]
}

This file is auto-generated by Lamatic Studio. Do not hand-edit it unless you understand the node/edge schema.

2.2 inputs.json — Input Schema

Contains the input schema for dynamic nodes. This may be an empty object {} if your flow has no configurable inputs.

2.3 meta.json — Flow Metadata

Contains the flow's display information. Make sure all fields are filled in:

{
    "name": "Your Flow Name",
    "description": "Clear description of what this flow does and when to use it.",
    "tags": ["🚀 Category"],
    "testInput": null,
    "githubUrl": "",
    "documentationUrl": "",
    "deployUrl": "https://studio.lamatic.ai/template/<template-name>",
    "author": {
        "name": "Your Name",
        "email": "your@email.com"
    }
}

Fill in at minimum: name, description, tags, and author.

2.4 README.md — Flow Documentation

The export includes an auto-generated README. Check that it contains:

  • What the flow does
  • Flow components / node types used
  • Files included
  • Usage instructions

Step 3: Enhance Your README

The auto-generated README is a starting point. Enhance it to help other users understand and use your flow.

3.1 Add a Deploy Button

Add this at the top of your README (replace <template-name> with your folder name):

<a href="https://studio.lamatic.ai/template/<template-name>" target="_blank" style="text-decoration:none;">
  <div align="right">
    <span style="display:inline-block;background:#e63946;color:#fff;border-radius:6px;padding:10px 22px;font-size:16px;font-weight:bold;letter-spacing:0.5px;text-align:center;transition:background 0.2s;box-shadow:0 2px 8px 0 #0001;">Deploy on Lamatic</span>
  </div>
</a>

3.2 Recommended README Sections

  • About This Flow — What it does, what problem it solves, when to use it
  • Flow Components — List the node types used (e.g., LLMNode, graphqlNode, codeNode)
  • Files Included — Brief description of each file
  • Usage — Steps to import, configure, and test
  • Required Configurations — Any credentials or providers needed
  • Tags — Comma-separated tags for discoverability

See existing templates for reference: templates/get-started/README.md

Step 4: Open a Pull Request

4.1 Push Your Branch

git checkout -b feat/<template-name>-template
git add templates/<template-name>
git commit -m "feat: Add <template-name> template"
git push origin feat/<template-name>-template

4.2 PR Checklist

- [ ] Folder structure follows `templates/<template-name>/`
- [ ] All 4 flow files present (config.json, inputs.json, meta.json, README.md)
- [ ] `meta.json` has name, description, tags, and author filled in
- [ ] README describes what the flow does and how to use it
- [ ] No secrets committed

Examples & References

Resource Link
Get Started (basic example) templates/get-started/
Blog Writer Agent templates/blog-writer-agent/
RAG Chatbot templates/rag-chatbot/
Article Summariser templates/article-summariser/

Need Help?