https://github.com/boostercloud/rocket-static-sites-aws-infrastructure
Booster rocket to deploy static sites to Booster applications in AWS
https://github.com/boostercloud/rocket-static-sites-aws-infrastructure
Last synced: 3 months ago
JSON representation
Booster rocket to deploy static sites to Booster applications in AWS
- Host: GitHub
- URL: https://github.com/boostercloud/rocket-static-sites-aws-infrastructure
- Owner: boostercloud
- Created: 2021-03-02T06:47:07.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-11-12T16:42:54.000Z (over 4 years ago)
- Last Synced: 2025-03-02T02:54:02.655Z (over 1 year ago)
- Language: TypeScript
- Size: 314 KB
- Stars: 0
- Watchers: 7
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Static Sites Booster Rocket for AWS
This package is a configurable Booster rocket to add static site deployment to your Booster applications. It uploads your root.
## Usage
Install this package as a dev dependency in your Booster project (It's a dev dependency because it's only used during deployment, but we don't want this code to be uploaded to the project lambdas)
```sh
npm install --save-dev @boostercloud/rocket-static-sites-aws-infrastructure
```
In your Booster config file, pass a `RocketDescriptor` in the `config.rockets` array to configuring the static site rocket:
```typescript
import { Booster } from '@boostercloud/framework-core'
import { BoosterConfig } from '@boostercloud/framework-types'
Booster.configure('development', (config: BoosterConfig): void => {
config.appName = 'my-store'
config.rockets = [
{
packageName: '@boostercloud/rocket-static-sites-aws-infrastructure',
parameters: {
bucketName: 'test-bucket-name', // Required
rootPath: './frontend/dist', // Defaults to ./public
indexFile: 'main.html', // File to render when users access the CLoudFormation URL. Defaults to index.html
errorFile: 'error.html', // File to render when there's an error. Defaults to 404.html
}
},
]
})
```