{"id":15362943,"url":"https://github.com/sdd/serverless-apig-s3","last_synced_at":"2025-04-15T07:30:58.032Z","repository":{"id":20133557,"uuid":"88657068","full_name":"sdd/serverless-apig-s3","owner":"sdd","description":null,"archived":false,"fork":false,"pushed_at":"2023-12-15T08:22:41.000Z","size":29,"stargazers_count":29,"open_issues_count":7,"forks_count":7,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-04-14T23:10:32.096Z","etag":null,"topics":["aws","aws-apigateway","aws-lambda","aws-s3","serverless","serverless-plugin"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/sdd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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-04-18T18:23:40.000Z","updated_at":"2022-08-20T08:44:52.000Z","dependencies_parsed_at":"2024-10-01T13:04:24.430Z","dependency_job_id":"7e5628b0-bda1-4488-96bb-53a464665a53","html_url":"https://github.com/sdd/serverless-apig-s3","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdd%2Fserverless-apig-s3","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdd%2Fserverless-apig-s3/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdd%2Fserverless-apig-s3/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdd%2Fserverless-apig-s3/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sdd","download_url":"https://codeload.github.com/sdd/serverless-apig-s3/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249026699,"owners_count":21200493,"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":["aws","aws-apigateway","aws-lambda","aws-s3","serverless","serverless-plugin"],"created_at":"2024-10-01T13:04:19.894Z","updated_at":"2025-04-15T07:30:57.483Z","avatar_url":"https://github.com/sdd.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# serverless-apig-s3\n\nThis Serverless plugin automates the process of both configuring AWS to serve static front-end\ncontent and deploying your client-side bundle.\n\nIt creates an S3 bucket to hold your front-end content, and adds two routes to API Gateway:\n\n * `GET / =\u003e bucket/index.html`\n * `GET /assets/* =\u003e bucket/*`\n\nThis allows your API and front-end assets to be served from the same domain, sidestepping\nany CORS issues. CloudFront is also not used. The combination of these two properties\nmakes this plugin a good fit for a dev stage environment.\n\n### Installation\n\n```bash\nnpm i -D serverless-apig-s3\n```\n\nThis plugin requires node \u003e 7.6 because fuck callbacks.\n\n### Configuration\n\nserverless.yml:\n\n```yaml\nplugins:\n - serverless-apig-s3\n\ncustom:\n  apigs3:\n    dist: client/dist    # path within service to find content to upload (default: client/dist)\n    dotFiles: true       # include files beginning with a dot in resources and uploads (default: false)\n    topFiles: true       # create routes for top-level files in dist folder (default: false)\n    resourceName: static # route path for static assets (default: assets)\n    resourcePath: /dist  # path prefix for assets in s3 bucket (default: '')\n```\n\n### Usage\n\n```bash\nsls deploy    # ensure that sls deploy has been run so that this plugin's resources exist.\nsls client deploy    # uploads client build artifacts to s3\n```\n\nSomething missing? More documentation? All Issues / PRs welcome at https://github.com/sdd/serverless-apig-s3\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsdd%2Fserverless-apig-s3","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsdd%2Fserverless-apig-s3","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsdd%2Fserverless-apig-s3/lists"}