https://github.com/neilkuan/cdk-budibase

Use AWS CDK deploy Budibase Server.
https://github.com/neilkuan/cdk-budibase

Last synced: 2 months ago
JSON representation

Use AWS CDK deploy Budibase Server.

• Host: GitHub
• URL: https://github.com/neilkuan/cdk-budibase
• Owner: neilkuan
• License: apache-2.0
• Created: 2023-03-25T05:57:28.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2025-03-20T00:22:13.000Z (2 months ago)
• Last Synced: 2025-03-20T05:13:53.741Z (2 months ago)
• Language: TypeScript
• Size: 2.73 MB
• Stars: 8
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![NPM version](https://badge.fury.io/js/cdk-budibase.svg)](https://badge.fury.io/js/cdk-budibase)

[![PyPI version](https://badge.fury.io/py/cdk-budibase.svg)](https://badge.fury.io/py/cdk-budibase)

[![release](https://github.com/neilkuan/cdk-budibase/actions/workflows/release.yml/badge.svg)](https://github.com/neilkuan/cdk-budibase/actions/workflows/release.yml)

![Downloads](https://img.shields.io/badge/-DOWNLOADS:-brightgreen?color=gray)

![npm](https://img.shields.io/npm/dt/cdk-budibase?label=npm&color=orange)

![PyPI](https://img.shields.io/pypi/dm/cdk-budibase?label=pypi&color=blue)

# Welcome to `cdk-budibase`

> [`BudiBase`](https://github.com/Budibase/budibase)  is open source! is Build apps, forms, and workflows that perfectly fit your business - so you can move forward, faster. Best of all.

> Use AWS CDK to create budibase server.

> data store in efs

- base resource:

  - vpc, ecs cluster, ecs service, efs

> ref: https://medium.com/devops-techable/learn-how-to-use-the-efs-mount-point-in-your-ecs-cluster-running-fargate-with-aws-cdk-e5c9df435c8b

### Architecture

![](./docs/arch.png)

### Deploy cdk-budibase via example [code](./src/integ.api.ts).

![](/docs/cdk-deploy.png)

```bash

# example cdk app diff.

npx aws-cdk@latest diff --app='npx ts-node src/integ.api.ts'

# example cdk app deploy.

npx aws-cdk@latest deploy --app='npx ts-node src/integ.api.ts'

# example cdk app destroy (in case you miss remove efs, you need to remove efs, and log group manually on aws console or via aws cli, sdk etc...).

npx aws-cdk@latest destroy --app='npx ts-node src/integ.api.ts'

```

### Use Constructs Library in CDK APP.

```ts

import { BudiBaseBaseResource } from 'cdk-budibase';

const app = new App();

const env = {

  account: process.env.CDK_DEFAULT_ACCOUNT,

  region: process.env.CDK_DEFAULT_REGION,

};

const stack = new Stack(app, 'MyStack', { env });

new BudiBaseBaseResource(stack, 'BudiBaseBaseResource');

```

### EFS

![](/docs/efs.png)

### BudiBase

![](/docs/admin-sign-up.png)

![](/docs/budibase-console.png)