{"id":19274018,"url":"https://github.com/sbstjn/serverless-s3bucket-sync","last_synced_at":"2025-04-21T22:33:27.538Z","repository":{"id":137671413,"uuid":"98642257","full_name":"sbstjn/serverless-s3bucket-sync","owner":"sbstjn","description":"Serverless Plugin to sync local folders with an S3 bucket","archived":false,"fork":false,"pushed_at":"2019-12-28T04:08:27.000Z","size":85,"stargazers_count":25,"open_issues_count":8,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-10T23:03:07.546Z","etag":null,"topics":["assets","aws","bucket","s3","serverless","sync"],"latest_commit_sha":null,"homepage":null,"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/sbstjn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-28T11:14:27.000Z","updated_at":"2025-03-07T04:45:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"c7209f4e-f2dc-4d80-9c93-17c4238220c5","html_url":"https://github.com/sbstjn/serverless-s3bucket-sync","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbstjn%2Fserverless-s3bucket-sync","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbstjn%2Fserverless-s3bucket-sync/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbstjn%2Fserverless-s3bucket-sync/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbstjn%2Fserverless-s3bucket-sync/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sbstjn","download_url":"https://codeload.github.com/sbstjn/serverless-s3bucket-sync/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250111220,"owners_count":21376609,"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":["assets","aws","bucket","s3","serverless","sync"],"created_at":"2024-11-09T20:44:49.960Z","updated_at":"2025-04-21T22:33:22.516Z","avatar_url":"https://github.com/sbstjn.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ⚡️ Serverless Plugin for S3 Sync\n\n[![npm](https://img.shields.io/npm/v/serverless-s3bucket-sync.svg)](https://www.npmjs.com/package/serverless-s3bucket-sync)\n[![CircleCI](https://img.shields.io/circleci/project/github/sbstjn/serverless-s3bucket-sync/master.svg)](https://circleci.com/gh/sbstjn/serverless-s3bucket-sync)\n[![license](https://img.shields.io/github/license/sbstjn/serverless-s3bucket-sync.svg)](https://github.com/sbstjn/serverless-s3bucket-sync/blob/master/LICENSE.md)\n[![Coveralls](https://img.shields.io/coveralls/sbstjn/serverless-s3bucket-sync.svg)](https://coveralls.io/github/sbstjn/serverless-s3bucket-sync)\n\nWith this plugin for [serverless](https://serverless.com), you can sync local folders to S3 buckets after your service is deployed.\n\n## Usage\n\nAdd the [NPM package](https://www.npmjs.com/package/serverless-s3bucket-sync) to your project:\n\n```bash\n# Via yarn\n$ yarn add serverless-s3bucket-sync\n\n# Via npm\n$ npm install serverless-s3bucket-sync\n```\n\nAdd the plugin to your `serverless.yml`:\n\n```yaml\nplugins:\n  - serverless-s3bucket-sync\n```\n\n## Configuration\n\nConfigure S3 Bucket syncing Auto Scaling in `serverless.yml` with references to your local folder and the name of the S3 bucket.\n\n```yaml\ncustom:\n  s3-sync:\n    - folder: relative/folder\n      bucket: bucket-name\n```\n\nThat's it! With the next deployment, [serverless](https://serverless.com) will sync your local folder `relative/folder` with the S3 bucket named `bucket-name`. \n\n## Sync\n\nYou can use `sls sync` to synchornize all buckets without deploying your serverless stack.\n\n## License\n\nFeel free to use the code, it's released using the [MIT license](LICENSE.md).\n\n## Contribution\n\nYou are welcome to contribute to this project! 😘 \n\nTo make sure you have a pleasant experience, please read the [code of conduct](CODE_OF_CONDUCT.md). It outlines core values and beliefs and will make working together a happier experience.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsbstjn%2Fserverless-s3bucket-sync","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsbstjn%2Fserverless-s3bucket-sync","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsbstjn%2Fserverless-s3bucket-sync/lists"}