{"id":19042479,"url":"https://github.com/serverless/serverless-client-s3","last_synced_at":"2025-04-06T06:13:35.239Z","repository":{"id":65412253,"uuid":"51894943","full_name":"serverless/serverless-client-s3","owner":"serverless","description":"A plugin to deploy front-end assets to S3 via the Serverless Framework","archived":false,"fork":false,"pushed_at":"2017-09-05T12:49:19.000Z","size":36,"stargazers_count":171,"open_issues_count":38,"forks_count":65,"subscribers_count":40,"default_branch":"master","last_synced_at":"2024-04-25T11:02:43.955Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://www.serverless.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/serverless.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-02-17T04:38:19.000Z","updated_at":"2024-03-13T08:23:50.000Z","dependencies_parsed_at":"2023-01-23T10:55:03.838Z","dependency_job_id":null,"html_url":"https://github.com/serverless/serverless-client-s3","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverless%2Fserverless-client-s3","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverless%2Fserverless-client-s3/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverless%2Fserverless-client-s3/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverless%2Fserverless-client-s3/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/serverless","download_url":"https://codeload.github.com/serverless/serverless-client-s3/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247441060,"owners_count":20939239,"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":[],"created_at":"2024-11-08T22:37:57.812Z","updated_at":"2025-04-06T06:13:35.223Z","avatar_url":"https://github.com/serverless.png","language":"JavaScript","readme":"**DEPRECATION NOTICE: The NPM package of this project is not compatiable with v1.0+ of the Serverless Framework. Please use [serverless-finch](https://github.com/fernando-mc/serverless-finch) for an updated fork of this project.**\n\nserverless-client-s3\n====================\n[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)\n[![gitter](https://img.shields.io/gitter/room/serverless/serverless.svg)](https://gitter.im/serverless/serverless)\n[![version](https://img.shields.io/npm/v/serverless-client-s3.svg)](https://www.npmjs.com/package/serverless-client-s3)\n[![downloads](https://img.shields.io/npm/dm/serverless-client-s3.svg)](https://www.npmjs.com/package/serverless-client-s3)\n[![dependencies](https://img.shields.io/david/serverless/serverless-client-s3.svg)](https://www.npmjs.com/package/serverless-client-s3)\n[![license](https://img.shields.io/npm/l/serverless-client-s3.svg)](https://www.npmjs.com/package/serverless-client-s3)\n\n\nA Serverless plugin that deploys a web client for your Serverless project to an S3 bucket, and make it publicaly available in seconds.\n\n**First**, install:\n\n```\nnpm install --save serverless-client-s3\n```\n**Second**, update `serverless.yml` by adding the following:\n\n```yaml\nplugins:\n  - serverless-client-s3\n custom:\n   client:\n     bucketName: serverless-client-bucketname\n```\n\n* **Warning:** The plugin will overwrite any data you have in the bucket name you set above if it already exists.\n\n\n**Third**, Create a `client/dist` folder in the root directory of your Serverless project. This is where your distribution-ready website should live. It is recommended to have a `client/src` where you'll be developing your website, and a build script that outputs to `client/dist`. The plugin simply expects and uploads the entire `client/dist` folder to S3, configure the bucket to host the website, and make it publicly available.\n\nOr just copy/run the following commands in the root directory of your Serverless project to get a quick sample website for deployment:\n\n```\nmkdir -p client/dist\ntouch client/dist/index.html\ntouch client/dist/error.html\necho \"Go Serverless\" \u003e\u003e client/dist/index.html\necho \"error page\" \u003e\u003e client/dist/error.html\n```\n\n**Fourth**, run the plugin, and visit your new website!\n\n```\nserverless client deploy [--stage $STAGE] [--region $REGION]\n```\n\n**Fifth**, Have fun!\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserverless%2Fserverless-client-s3","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fserverless%2Fserverless-client-s3","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserverless%2Fserverless-client-s3/lists"}