[![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.8",
"maintainer_email": null,
"keywords": null,
"author": "Neil Kuan<guan840912@gmail.com>",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/5a/34/149fba1f712738ef97052cf8ea36d2ce2a95f94f462f6a8db3caf9ed2a31/cdk-budibase-0.0.374.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.374",
"project_urls": {
"Homepage": "https://github.com/neilkuan/cdk-budibase.git",
"Source": "https://github.com/neilkuan/cdk-budibase.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c86a3e9938ff428b096e1b79d49ba82f8c9f8e05974a94a29d2cec06f65905c1",
"md5": "c8f0d35b1dd78410b87cd5fd9b92a05d",
"sha256": "d9ac066d46bb7fd9bafcbcb818783059ed145a7258d77af594ccda216743ab8b"
},
"downloads": -1,
"filename": "cdk_budibase-0.0.374-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c8f0d35b1dd78410b87cd5fd9b92a05d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 495741,
"upload_time": "2024-05-11T00:18:03",
"upload_time_iso_8601": "2024-05-11T00:18:03.588088Z",
"url": "https://files.pythonhosted.org/packages/c8/6a/3e9938ff428b096e1b79d49ba82f8c9f8e05974a94a29d2cec06f65905c1/cdk_budibase-0.0.374-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5a34149fba1f712738ef97052cf8ea36d2ce2a95f94f462f6a8db3caf9ed2a31",
"md5": "285c81f8d89a4ea28a6b020392f7c3d7",
"sha256": "34570fc9246fe3928ecc9dea0459caa1e85585f3bb64ed069dcb6abeae0ef697"
},
"downloads": -1,
"filename": "cdk-budibase-0.0.374.tar.gz",
"has_sig": false,
"md5_digest": "285c81f8d89a4ea28a6b020392f7c3d7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 497198,
"upload_time": "2024-05-11T00:18:20",
"upload_time_iso_8601": "2024-05-11T00:18:20.437456Z",
"url": "https://files.pythonhosted.org/packages/5a/34/149fba1f712738ef97052cf8ea36d2ce2a95f94f462f6a8db3caf9ed2a31/cdk-budibase-0.0.374.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-11 00:18:20",
"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"
}