{"id":19718952,"url":"https://github.com/marcgreenstock/data-api-suite","last_synced_at":"2025-06-19T07:35:01.370Z","repository":{"id":46178568,"uuid":"226492157","full_name":"marcgreenstock/data-api-suite","owner":"marcgreenstock","description":"Monorepo that includes libraries, Serverless Framework plugins and development tools to simplify and enhance the development, deployment and use of the Data API for Aurora Serverless. ","archived":false,"fork":false,"pushed_at":"2021-11-09T10:20:37.000Z","size":2051,"stargazers_count":20,"open_issues_count":6,"forks_count":11,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-17T08:43:47.794Z","etag":null,"topics":["aurora","data-api","local","offline","posgresql","serverless"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marcgreenstock.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-12-07T10:19:21.000Z","updated_at":"2024-10-03T09:44:08.000Z","dependencies_parsed_at":"2022-09-26T18:31:48.434Z","dependency_job_id":null,"html_url":"https://github.com/marcgreenstock/data-api-suite","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcgreenstock%2Fdata-api-suite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcgreenstock%2Fdata-api-suite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcgreenstock%2Fdata-api-suite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcgreenstock%2Fdata-api-suite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marcgreenstock","download_url":"https://codeload.github.com/marcgreenstock/data-api-suite/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251578393,"owners_count":21612031,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aurora","data-api","local","offline","posgresql","serverless"],"created_at":"2024-11-11T23:02:45.761Z","updated_at":"2025-04-29T20:31:06.096Z","avatar_url":"https://github.com/marcgreenstock.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Data API for Aurora Serverless Suite\n\n[![tests](https://github.com/marcgreenstock/data-api-suite/workflows/master/badge.svg)](https://github.com/marcgreenstock/data-api-suite/actions) [![codecov](https://codecov.io/gh/marcgreenstock/data-api-suite/branch/master/graph/badge.svg)](https://codecov.io/gh/marcgreenstock/data-api-suite)\n [![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)\n\nThe **Data API for Aurora Serverless Suite** is a [Monorepo](https://en.wikipedia.org/wiki/Monorepo) that includes libraries, [Serverless Framework](https://serverless.com/) plugins and development tools to simplity and enhance the development, deployment and use of the [Data API for Aurora Serverless](https://aws.amazon.com/blogs/aws/new-data-api-for-amazon-aurora-serverless/) on Amazon Web Services.\n\n## Packages\n\nEach package has its own `README` with independent documentation.\n\n### Node.js Libraries\n\n| Name                                                | Description                                                  |\n| --------------------------------------------------- | ------------------------------------------------------------ |\n| [Aurora Data API Client`](packages/aurora-data-api) | [![NPM](https://img.shields.io/npm/v/aurora-data-api.svg)](https://www.npmjs.com/package/aurora-data-api)\u003cbr /\u003eAn abstraction of the [RDSDataService](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/RDSDataService.html) that implements the [Data API for Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) and simplifies the request and response payloads. |\n\n### Serverless Framework Plugins\n\nThe following libraries are designed to work with the [Serverless Framework](https://serverless.com/).\n\n| Name                                                         | Description                                                  |\n| ------------------------------------------------------------ | ------------------------------------------------------------ |\n| [Data API Local Serverless Plugin](packages/data-api-local-serverless) | [![NPM](https://img.shields.io/npm/v/data-api-local-serverless.svg)](https://www.npmjs.com/package/data-api-local-serverless)\u003cbr /\u003eA Serverless plugin to start a local Aurora Serverless Data API emulator for offline development that plays nice with [`serverless-ofline`](https://github.com/dherault/serverless-offline). |\n| [Data API Migrations Serverless Plugin](packages/data-api-migrations-serverless) | [![NPM](https://img.shields.io/npm/v/data-api-migrations-serverless.svg)](https://www.npmjs.com/package/data-api-migrations-serverless)\u003cbr /\u003eA Serverless plugin to generate, apply and rollback migrations on the Data API for Aurora Serverless. Plays nice with [Data API Local Serverless](packages/data-api-local-serverless). |\n\n### Node.js Local Development Tools\n\nThe following libraries are designed to be used in a node.js environment.\n\n| Package Name | Description |\n| ---- | ----------- |\n| [Data API Local](packages/data-api-local) | [![NPM](https://img.shields.io/npm/v/data-api-local.svg)](https://www.npmjs.com/package/data-api-local)\u003cbr /\u003eThis is the core library for Data API Local Serverless Plugin. Use this libary if you're not using Serverless and need to programatically start an emulator in your node.js application. |\n| [Data API Migrations](packages/data-api-migrations) | [![NPM](https://img.shields.io/npm/v/data-api-migrations.svg)](https://www.npmjs.com/package/data-api-migrations)\u003cbr /\u003eThis is the foundation library for the Data API Migrations Serverless Plugin. Use this library if you're not using Serverless. |\n\n## Example\n\nTake a look at the [example folder](https://github.com/marcgreenstock/data-api-suite/tree/master/example) for a complete example app that uses all the **Data API for Aurora Serverless Suite** packages.\n\n## Contributing\n\n### Installing\n\n```sh\n$ git clone git@github.com:marcgreenstock/data-api-local.git\n$ cd data-api-local\n$ npm install\n$ npm run bootstrap # this runs lerna bootstrap to run npm install on each package and npm link the packages together.\n```\n\n### Testing\n\nWe're using [docker-compose.yml](docker-compose.yml) to create a local MySQL and PostgreSQL database with seed data from the files in the [initdb](initdb) directory.\n\n```sh\n$ docker-compose up --build -d # start the test databases\n$ docker ps -a # check the processes are running\n$ npm test\n```\n\n## MIT License\n\nCopyright (c) 2020 Marc Greenstock\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcgreenstock%2Fdata-api-suite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarcgreenstock%2Fdata-api-suite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcgreenstock%2Fdata-api-suite/lists"}