/templates

⚡️ A collection of open-source solution templates to integrate within Buildable Flows.

Primary LanguageJavaScriptMIT LicenseMIT

Header

Buildable GitHub stars GitHub contributors GitHub pull requests GitHub commit activity GitHub issues GitHub closed issues GitHub release (latest by date) GitHub license Twitter Follow


Buildable ⚡️

Buildable is an instant backend tool that makes a software developer’s day more delightful. We’re helping engineers breeze through feature development using enterprise-grade tools.

  • One-click Databases (Hosted and Self-Hosted)
  • Auto-generated APIs
  • 1,500+ Open-Source Integration Templates for Coinbase, Stripe, Shopify and hundreds more!
  • Managed infrastructure
  • Dashboard

How to Contribute 🚀

Publishing to the community

To get started with publishing your own templates, take a look at the CONTRIBUTING.md file.

Creating your own private templates (BETA)

If you'd like to create private templates that are only accessible in your Buildable account, you can do so by publishing privately. This feature is currently still in Beta so if you'd like access, send us a request by emailing friends@buildable.dev for a private publishing token.

Documentation 📖

For full documentation, visit docs.buildable.dev

To get to know Buildable, visit Getting Started

Community & Support 👥

  • GitHub Issues. Best for: bugs and errors you encounter using Buildable
  • Discord. Best for help with building, discussion about logic best practices, sharing your Flows and hanging out with the community
  • Email Support. Best For: problems with your Flows or infrastructure

What are Templates? 🤔

Buildable Templates is a collection of open-source functions that save developers hundreds of hours when integrating databases, apps and other complicated logic. They work natively with Buildable Flows, which means you can build, test, deploy any integration using Templates in a matter of minutes.

Getting Started 🏁

To get access to the entire library, simply create a free developer account on Buildable and follow the onboarding tutorial once your developer account is activated. The entire process takes less than 5 minutes.

To add a Template to your Flow, simply press the + button to expose the Template Library, where you can instantly integrate any template within your Flow!

Adding Templates in Buildable

How Templates Work ⚙️

Each Node Template is composed of an input and run function. Together, they should represent one logic step with a single purpose (i.e. Sending an email with Sendgrid).

The Input Function

The input function’s sole purpose is to select the data that will be passed into the run function.

It has access to:

  • $trigger - The Flow's request object
  • $nodes - The outputs of all Nodes above itself

⚠️ It’s important to make sure your input function is only used for selection and not for processing. Following best practices, you shouldn’t write any logic within the Input function. To enforce this, Buildable purposefully allocates lower resources to input functions.

The Run Function

The run function is where you write the processing and logic of your node. Whatever is returned in the run function will be the response of the node.

It has access to:

  • input - The values passed in from the input function

You can view a sample run function in the /sample directory.

Demos and Tutorials 📹

We've also got a library of on-demand demo videos and tutorials where we showcase how to use core features in Buildable along with building out real world examples.

You can find these resources below:

Status 🚥

  • Alpha: Testing Buildable with a closed set of advisors, investors and technologists
  • Private Beta: Closed to a set of early community members and enterprise customers
  • Public Beta: Anyone with an invite code can sign up and invite others to the platform
  • Public: Production-ready and open to everyone
  • Scale: Support for large organizations (50+ seats)

🎉 Buildable is currently availably publicly and is no longer invite-only!

Watch this repo to stay notified on all updates ⬇️

Star and Watch

Roadmap 🗺

Stay up to date with our roadmap on UpVoty, where you can request and vote for app features and new templates!

Contributors ❤️

Bravo and a special thanks to all the awesome people who've contributed to the Template library!

Want to chat? 📬

We'd love to! Reach out to us on Discord or shoot over an email to friends@buildable.dev.


License

© 2022, Buildable Technologies Inc. - Released under the MIT License