Quick Start

Flank exposes real-time access to code for any teammate to start using with or without coding experience

At the heart of Flank is connecting code resources (SQL DBs, APIs, AWS accounts, etc) and exposing them as runnable commands.

Commands are essentially a UI that connects to an individual piece from a larger code resource.

Resource
Command

AWS

Lambdas & step-functions

SQL Databases

SQL functions & stored procedures

APIs

HTTP Methods (GET, POST, PUT, etc)

We think the best way to experience Flank is to build and use a tool in under 5 minutes. Here's the steps we'll take.

  1. Connect to an outside code service and auto-generate a basic set of commands

  2. Try running a command

  3. Stitch together commands in a multistage workflow

  4. Share it with your friends, teammates, or even the whole internet.

All of this will happen before an SNL host can finish a monologue.

Connecting to a Code Service

We recommend using one of the following options to test Flank as quickly as possible.

  • Flank's AWS sandbox creds

  • Flank's DB sandbox creds

  • Twilio API creds

Choose which service you want to try out and put those creds in the onboarding flow. Then click create org. Once you've landed on the Flank homepage, click on the sync button and select the credentials you just added.

Flank will scan the resources associated with the creds and automatically generate a command for each respective API endpoint, SQL stored procedure, AWS lambda, etc.

Running your First Building Block

After the resource is done syncing, click on one of the commands in the table. It will take you to the single command page. The command page is a user-interface for that specific piece of backend code (API endpoint, a SQL query, etc).

If the command has parameters, you'll be prompted to input values matching the source code's types. Whenever you're ready, click the run button and view the results.

After you've run it once, try changing the parameters and running it again. Flank uses an index card-like interface so you can quickly compare data across multiple run results.

Building your First Complex Kit

After running your first command, its time to see how you can step things up a level. Try combining any two legos together using the dropdown feature. This allows you to build more refined tools to share with your teammates and ensure the data they are using is accurate.

Share it with People

Either from the list of kits or in the kit itself, click the share button.

From this menu you can typically share resources with teammates and give them the permission to either edit or run it. Since your org is probably empty right now, try setting the kit to public. Then click the copy button next to it and share that URL with whoever to give them access to run the tool you just built.

WOO! You're done!

If you're interested in seeing how Flank can work with your own resources, continue to the Connecting Services page and learn how to get set up.

Last updated