-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #46 from buildable/development
Development -> Main
- Loading branch information
Showing
15,336 changed files
with
235,020 additions
and
235,065 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,8 @@ | ||
| # Dependency directories | ||
| node_modules/ | ||
|
|
||
| coverage | ||
|
|
||
| # Optional npm cache directory | ||
| .npm | ||
|
|
||
|
|
||
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,118 +1,77 @@ | ||
|
|
||
|  | ||
|  | ||
|
|
||
| [](https://buildable.dev) [](https://github.com/buildable/templates/stargazers)    [](https://github.com/buildable/templates/issues)   [](https://github.com/buildable/templates) [](https://twitter.com/BuildableHQ) | ||
|
|
||
| --- | ||
|
|
||
| ## Buildable ⚡️ | ||
|
|
||
| [Buildable](https://buildable.dev/) 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. | ||
|
|
||
| - [x] One-click Databases (Hosted and Self-Hosted) | ||
| - [x] Auto-generated APIs | ||
| - [x] 1,500+ Open-Source Integration Templates for Coinbase, Stripe, Shopify and hundreds more! | ||
| - [x] Managed infrastructure | ||
| - [x] Dashboard | ||
|
|
||
| ## How to Contribute 🚀 | ||
|
|
||
| ### Publishing to the community | ||
| To get started with publishing your own templates, take a look at the [CONTRIBUTING.md](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 `[email protected]` for a private publishing token. | ||
|
|
||
| ## Documentation 📖 | ||
| ## What is Buildable? | ||
|
|
||
| For full documentation, visit [docs.buildable.dev](https://docs.buildable.dev) | ||
| [Buildable](https://buildable.dev/) is the easiest way to collect, transform, send and action your backend system events. Buildable simplifies the process of collecting event data from your disparate systems and connecting new tools to action those events, allowing you to spend more of your engineering time on things that matter. | ||
|
|
||
| To get to know Buildable, visit [Getting Started](https://docs.buildable.dev/introduction/getting-started) | ||
| When you capture event data in Buildable, you can send them in real-time to your databases, sales, analytics, payment, communication and eCommerce tools. In most cases, you'll be able to set up a Connection once and forget about it forever. | ||
|
|
||
| ## Community & Support 👥 | ||
|  | ||
|
|
||
| - [GitHub Issues](https://github.com/buildable/templates/issues). Best for: bugs and errors you encounter using Buildable | ||
| - [Discord](https://discord.com/invite/47AJ42Wzys). Best for help with building, discussion about logic best practices, sharing your Flows and hanging out with the community | ||
| - [Email Support](https://docs.buildable.dev/help/need-support). Best For: problems with your Flows or infrastructure | ||
| ## How can Buildable help you? | ||
|
|
||
| ## What are Templates? 🤔 | ||
| **[Simplify event collection](https://docs.buildable.dev/connections/source-catalog)** | ||
|
|
||
| [Buildable Templates](https://docs.buildable.dev/core-products/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](https://docs.buildable.dev/core-products/flows), which means you can build, test, deploy any integration using Templates in a matter of minutes. | ||
| Start by integrating the tools you use for data storage, notifications, payments, sales and more. | ||
|
|
||
| ## Getting Started 🏁 | ||
| **[Audit system-wide activity](https://docs.buildable.dev/streams/viewing-events)** | ||
|
|
||
| To get access to the entire library, simply [create a free developer account](https://welcome.buildable.dev) on Buildable and follow the onboarding tutorial once your developer account is activated. The entire process takes less than 5 minutes. | ||
| Query and review a central stream of all backend activity happening across all platforms. | ||
|
|
||
| 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! | ||
| **[Ship and scale code](https://docs.buildable.dev/workflows/building-workflows)** | ||
|
|
||
| [](https://buildable.dev) | ||
| Save hundreds of development hours by setting up webhooks and connecting APIs in minutes | ||
|
|
||
| ## How Templates Work ⚙️ | ||
| ## Getting started | ||
|
|
||
| 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). | ||
| Your first pipeline can be operational within 10 minutes: | ||
|
|
||
| ### The Input Function | ||
| The input function’s sole purpose is to select the data that will be passed into the run function. | ||
| 1. Sign in at [https://app.buildable.dev/sign-in](https://app.buildable.dev/sign-in) | ||
| 2. Connect a Source using our [Source Catalog](https://docs.buildable.dev/connections/source-catalog) or SDKs | ||
| 3. View your events in your [Event Stream](https://docs.buildable.dev/streams/viewing-events) | ||
| 4. Connect an [Action Provider](https://docs.buildable.dev/connections/action-catalog) | ||
| 5. [Create a Workflow](https://docs.buildable.dev/workflows/building-workflows) to action your events | ||
|
|
||
| It has access to: | ||
| [](https://www.youtube.com/watch?v=JUpjxvqAM6w&feature=emb_imp_woyt) | ||
|
|
||
| - `$trigger` - The Flow's request object | ||
| - `$nodes` - The outputs of all Nodes above itself | ||
| ## Contributing to Connections | ||
|
|
||
| ⚠️ 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. | ||
| Buildable’s core engineering team will be reviewing and merging submissions from customers and the community daily. | ||
|
|
||
| ### 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. | ||
| If we’re missing an event source your team needs, for example, you can build it using our samples within a few hours or request it our Public Roadmap. | ||
|
|
||
| It has access to: | ||
| Learn more in our [source documentation](/sources/docs/CONTRIBUTING.md). | ||
|
|
||
| - `input` - The values passed in from the input function | ||
| ## New more help? | ||
|
|
||
| You can view a sample `run` function in the `/sample` directory. | ||
| Learn more about Buildable 👇 | ||
|
|
||
| ## Demos and Tutorials 📹 | ||
| 💻 Website: [https://buildable.dev](https://buildable.dev/) | ||
|
|
||
| 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. | ||
| 🏁 Get started: [https://app.buildable.dev/sign-in](https://app.buildable.dev/sign-in) | ||
|
|
||
| You can find these resources below: | ||
| - [On-Demand Demos](https://www.buildable.dev/on-demand-demos) | ||
| - [Tutorials](https://www.buildable.dev/tutorials) | ||
| 📄 Docs: [https://docs.buildable.dev](https://docs.buildable.dev/) | ||
|
|
||
| ## Status 🚥 | ||
| - [x] Alpha: Testing Buildable with a closed set of advisors, investors and technologists | ||
| - [x] Private Beta: Closed to a set of early community members and enterprise customers | ||
| - [x] Public Beta: Anyone with an invite code can sign up and invite others to the platform | ||
| - [x] Public: Production-ready and open to everyone | ||
| - [ ] Scale: Support for large organizations (50+ seats) | ||
| 💬 Discord: [https://discord.com/invite/47AJ42Wzys](https://discord.com/invite/47AJ42Wzys) | ||
|
|
||
| 🎉 Buildable is currently availably publicly and is no longer invite-only! | ||
| 🐦 Twitter: [https://twitter.com/BuildableHQ](https://twitter.com/BuildableHQ) | ||
|
|
||
| Watch this repo to stay notified on all updates ⬇️ | ||
| 🚥 Roadmap: [https://roadmap.buildable.dev](https://roadmap.buildable.dev) | ||
|
|
||
| [](https://buildable.dev) | ||
| 📣 Changelog: [https://buildable.dev/changelog](https://buildable.dev/changelog) | ||
|
|
||
| ## Roadmap 🗺 | ||
| ## Contributors | ||
|
|
||
| <a href="https://roadmap.buildable.dev/"> | ||
| <img src="https://assets.buildable.dev/catalog/graphics/upvoty.png" width="150" /> | ||
| </a> | ||
|
|
||
| Stay up to date with our roadmap on [UpVoty](https://roadmap.buildable.dev/), 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! | ||
| Supported by a network of early advocates, contributors, and champions! | ||
|
|
||
| <a href="https://github.com/buildable/templates/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=buildable/templates" /> | ||
| <a href="https://github.com/buildable/connections/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=buildable/connections" /> | ||
| </a> | ||
|
|
||
| ## Want to chat? 📬 | ||
|
|
||
| We'd love to! Reach out to us on [Discord](https://discord.gg/uKydsjsVga) or shoot over an email to [[email protected]](mailto:[email protected]). | ||
|
|
||
| <br /> | ||
|
|
||
| ### License | ||
|
|
||
| © 2022, Buildable Technologies Inc. - Released under the MIT License |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # What are Action Templates? | ||
|
|
||
| [Action Templates](/actions/catalog/) are open-source functions that save developers hundreds of hours when integrating databases, apps and other complicated logic. They work natively with [Buildable Workflows](https://docs.buildable.dev/workflows/building-workflows), which means you can build, test, deploy any integration using Templates in a matter of minutes. | ||
|
|
||
| Check out the [contribution guidelines](/actions/docs/CONTRIBUTING.md) to start creating your own Actions. | ||
|
|
||
| ## How Templates Work | ||
|
|
||
| Each Action Template is comprised 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: | ||
|
|
||
| - `$body` - The Workflow's body | ||
| - `$headers` - The Workflow's headers | ||
| - `$env` - Your Environment Variables | ||
| - `$actions` - The outputs of all Actions above itself | ||
| - `$query` - The Workflow's query | ||
|
|
||
| ⚠️ 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 Action. Whatever is returned in the run function will be the response of the Action. | ||
|
|
||
| It has access to: | ||
|
|
||
| - `input` - The values passed in from the input function | ||
|
|
||
| You can view a sample `run` function in the [sample directory](/actions/sample/). | ||
|
|
||
| ## Read More | ||
|
|
||
| Check out [docs.buildable.dev](https://docs.buildable.dev) to read more on Actions and Workflows. | ||
| - [Actions Catalog](https://docs.buildable.dev/connections/action-catalog) | ||
| - [Building Workflows](https://docs.buildable.dev/workflows/building-workflows) | ||
| - [Managing Workflows](https://docs.buildable.dev/workflows/managing-workflows) |
File renamed without changes.
Oops, something went wrong.