# cdk-website

> An AWS CDK construct to instantly deploy a static website on serverless infrastructure. Easy, fast, done.

Latest version **0.0.5** (published 2020-10-29) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install cdk-website
pnpm add cdk-website
yarn add cdk-website
bun add cdk-website
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2020-10-29 |
| First published | 2020-10-28 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >= 10.17.0 |
| Dependencies | 7 |
| Unpacked size | 84.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Emanuele Ricci |
| Maintainers | e.ricci |
| Keywords | angular, cdk, react, spa, vue, website |

## Links

- npm: https://www.npmjs.com/package/cdk-website
- Repository: https://github.com/stermi/cdk-website
- Homepage: https://github.com/stermi/cdk-website#readme
- Issues: https://github.com/stermi/cdk-website/issues
- npm.io page: https://npm.io/package/cdk-website

## Dependencies (7)

- [@aws-cdk/core](https://npm.io/package/@aws-cdk/core.md) ^1.69.0
- [@aws-cdk/aws-s3](https://npm.io/package/@aws-cdk/aws-s3.md) ^1.69.0
- [@aws-cdk/aws-route53](https://npm.io/package/@aws-cdk/aws-route53.md) ^1.69.0
- [@aws-cdk/aws-cloudfront](https://npm.io/package/@aws-cdk/aws-cloudfront.md) ^1.69.0
- [@aws-cdk/aws-s3-deployment](https://npm.io/package/@aws-cdk/aws-s3-deployment.md) ^1.69.0
- [@aws-cdk/aws-route53-targets](https://npm.io/package/@aws-cdk/aws-route53-targets.md) ^1.69.0
- [@aws-cdk/aws-certificatemanager](https://npm.io/package/@aws-cdk/aws-certificatemanager.md) ^1.69.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.0.5 (latest) — 2020-10-29
- 0.0.3 — 2020-10-29
- 0.0.2 — 2020-10-28

## README

# cdk-website

An [AWS CDK](https://github.com/awslabs/aws-cdk) construct to instantly deploy a static website on serverless infrastructure. Easy, fast, done.

## Installation

Use the package manager npm to install cdk-website.

```bash
npm install cdk-website
```

## Usage

```ts
import { Construct, Stack, StackProps } from '@aws-cdk/core'
import { WebsiteProps, Website } from 'cdk-website'

export class CdkStack extends Stack {
    constructor(scope: Construct, id: string, props: StackProps) {
        super(scope, id, props)

        const websiteProps: WebsiteProps = {
            domain: 'aws.com',
            subdomain: 'awesome-cdk',
            websiteFolder: '../website/dist',
            indexDoc: 'index.html',
            errorDoc: 'index.html',
        }

        new Website(this, `Website`, websiteProps).deploy()
    }
}

```

## Road map

 - [ ] Add more tests
 - [ ] Add support for only domain
 - [ ] Add more configurable options if needed


## Contributing

Contributions of all kinds are welcome and celebrated. Raise an issue, submit a PR, do the right thing.

To set up a dev environment:

1. Clone repo
2. `yarn install`

Development workflow (change code and run tests automatically):

```shell
yarn test:watch
```

Build (like CI):

```shell
yarn build
```

Release new versions:

```shell
yarn bump
```

And then publish as a PR.

## License

[Apache 2.0](https://github.com/eladb/cdk-watchful/blob/master/LICENSE)

---
_Source: https://npm.io/package/cdk-website · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._