Skip to content

serverless-components/website

 
 

website

 

Deploy a static website to AWS S3 in seconds using Serverless Components.

 

  1. Install
  2. Create
  3. Configure
  4. Deploy

 

1. Install

$ npm install -g @serverless/components

2. Create

$ mkdir my-website $ cd my-website

the directory should look something like this:

|- code |- index.html |- serverless.yml |- .env # your development AWS api keys |- .env.prod # your production AWS api keys 

the .env files are not required if you have the aws keys set globally and you want to use a single stage, but they should look like this.

AWS_ACCESS_KEY_ID=XXX AWS_SECRET_ACCESS_KEY=XXX 

The code directory could either be a simple directory of html/css/js assets files, or a full fledged React app.

3. Configure

# serverless.yml name: my-website stage: dev myWebsite: component: "@serverless/website" inputs: code: root: ./ # The root folder of your website project. Defaults to current working directory src: ./src # The folder to be uploaded containing your built artifact hook: npm run build # A hook to build/test/do anything to your code before uploading region: us-east-1 # The AWS region to deploy your website into env: # Environment variables to include in a 'env.js' file with your uploaded code. API_URL: https://api.com

4. Deploy

website (master)$ ⚡️components  Website › outputs:  url: 'http://serverless-0c4351.s3-website-us-east-1.amazonaws.com'  6s › dev › Website › done website (master)$ 

 

New to Components?

Checkout the Serverless Components repo for more information.

About

⚡ Instantly deploy static website on serverless infrastructure with zero configuration using Serverless Components.

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 11