cdk-budibase


Namecdk-budibase JSON
Version 0.0.722 PyPI version JSON
download
home_pagehttps://github.com/neilkuan/cdk-budibase.git
SummaryUse AWS CDK to create budibase server
upload_time2025-07-16 00:25:15
maintainerNone
docs_urlNone
authorNeil Kuan<guan840912@gmail.com>
requires_python~=3.9
licenseApache-2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![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.

```python
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)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/neilkuan/cdk-budibase.git",
    "name": "cdk-budibase",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "~=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Neil Kuan<guan840912@gmail.com>",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/3e/15/cc4a00516a73085c4a6f630cd67927629574e64a40f11fdab3b970f31bf1/cdk_budibase-0.0.722.tar.gz",
    "platform": null,
    "description": "[![NPM version](https://badge.fury.io/js/cdk-budibase.svg)](https://badge.fury.io/js/cdk-budibase)\n[![PyPI version](https://badge.fury.io/py/cdk-budibase.svg)](https://badge.fury.io/py/cdk-budibase)\n[![release](https://github.com/neilkuan/cdk-budibase/actions/workflows/release.yml/badge.svg)](https://github.com/neilkuan/cdk-budibase/actions/workflows/release.yml)\n\n![Downloads](https://img.shields.io/badge/-DOWNLOADS:-brightgreen?color=gray)\n![npm](https://img.shields.io/npm/dt/cdk-budibase?label=npm&color=orange)\n![PyPI](https://img.shields.io/pypi/dm/cdk-budibase?label=pypi&color=blue)\n\n# Welcome to `cdk-budibase`\n\n> [`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.\n> Use AWS CDK to create budibase server.\n> data store in efs\n\n* base resource:\n\n  * vpc, ecs cluster, ecs service, efs\n\n> ref: https://medium.com/devops-techable/learn-how-to-use-the-efs-mount-point-in-your-ecs-cluster-running-fargate-with-aws-cdk-e5c9df435c8b\n\n### Architecture\n\n![](./docs/arch.png)\n\n### Deploy cdk-budibase via example [code](./src/integ.api.ts).\n\n![](/docs/cdk-deploy.png)\n\n```bash\n# example cdk app diff.\nnpx aws-cdk@latest diff --app='npx ts-node src/integ.api.ts'\n\n# example cdk app deploy.\nnpx aws-cdk@latest deploy --app='npx ts-node src/integ.api.ts'\n\n# 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...).\nnpx aws-cdk@latest destroy --app='npx ts-node src/integ.api.ts'\n```\n\n### Use Constructs Library in CDK APP.\n\n```python\nimport { BudiBaseBaseResource } from 'cdk-budibase';\n\nconst app = new App();\nconst env = {\n  account: process.env.CDK_DEFAULT_ACCOUNT,\n  region: process.env.CDK_DEFAULT_REGION,\n};\n\nconst stack = new Stack(app, 'MyStack', { env });\nnew BudiBaseBaseResource(stack, 'BudiBaseBaseResource');\n```\n\n### EFS\n\n![](/docs/efs.png)\n\n### BudiBase\n\n![](/docs/admin-sign-up.png)\n![](/docs/budibase-console.png)\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Use AWS CDK to create budibase server",
    "version": "0.0.722",
    "project_urls": {
        "Homepage": "https://github.com/neilkuan/cdk-budibase.git",
        "Source": "https://github.com/neilkuan/cdk-budibase.git"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "14cec5b8aaad2994935aba93193a1385f9c006366e4ba96b3f97391fe3fbd69e",
                "md5": "d6b7276dbd57313761afb41a895b9242",
                "sha256": "8e6d43c5f67fafec30a544dd51230ae452b2684e2f5843edfc8c1b7ee970c853"
            },
            "downloads": -1,
            "filename": "cdk_budibase-0.0.722-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d6b7276dbd57313761afb41a895b9242",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "~=3.9",
            "size": 497434,
            "upload_time": "2025-07-16T00:25:14",
            "upload_time_iso_8601": "2025-07-16T00:25:14.292547Z",
            "url": "https://files.pythonhosted.org/packages/14/ce/c5b8aaad2994935aba93193a1385f9c006366e4ba96b3f97391fe3fbd69e/cdk_budibase-0.0.722-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "3e15cc4a00516a73085c4a6f630cd67927629574e64a40f11fdab3b970f31bf1",
                "md5": "1d2bb1ab835590d5e265227ede8b0ac5",
                "sha256": "86d609350b6f3ab78f98dd33c5672db0213716b3ee885a32e2309c387a3ed7ea"
            },
            "downloads": -1,
            "filename": "cdk_budibase-0.0.722.tar.gz",
            "has_sig": false,
            "md5_digest": "1d2bb1ab835590d5e265227ede8b0ac5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "~=3.9",
            "size": 498623,
            "upload_time": "2025-07-16T00:25:15",
            "upload_time_iso_8601": "2025-07-16T00:25:15.995912Z",
            "url": "https://files.pythonhosted.org/packages/3e/15/cc4a00516a73085c4a6f630cd67927629574e64a40f11fdab3b970f31bf1/cdk_budibase-0.0.722.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-16 00:25:15",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "neilkuan",
    "github_project": "cdk-budibase",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "cdk-budibase"
}
        
Elapsed time: 0.96996s