Skip to content

Build your first app

Make sure to first sign up at and create or join an organization.

Setup starter project

Clone starter project, install dependencies and start Buttonize local development.

Node.js version >= 20 is required.

Terminal window
npx create-buttonize && \
cd my-buttonize-app && npm install && \
npx buttonize dev bin/cdk.ts


If you go through the onboarding tutorial on we will show you commands containing also an API Key value.

Buttonize API Key is crucial for deploying Buttonize apps. In case you don’t see the API key or you don’t want to go through the onboarding, you can create an API Key here.

Once you have the API key, make sure to call Buttonize.init at the beginning of your CDK stack.

4 collapsed lines
import * as cdk from 'aws-cdk-lib'
import { Buttonize } from 'buttonize/cdk'
import { Construct } from 'constructs'
export class ExampleStack extends cdk.Stack {
constructor(scope: Construct, id: string, props?: cdk.StackProps) {
super(scope, id, props)
Buttonize.init(this, {

Local development

Once you start local development with buttonize dev you can go to to view your application.

Buttonize CLI monitors changes in your CDK code and always renders the latest version of the app. In case the app is deployed Buttonize CLI fetches all the necessary information from AWS to make sure the app is fully working also locally.

Local development

App deployment

Since Buttonize seamlessly integrates into your CDK application as a CDK Construct, you can deploy your Buttonize apps just by executing standard deployment commands.

Terminal window
cdk deploy

Once you deploy the app, you can go to and you will see your app right there.

List of the apps

And the application itself looks like this.

App view

You have deployed your first Buttonize app

Congrats! Let us know how you liked it on Discord.