Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rishikeshdarandale/website-deploy
A simple utility to deploy a static website to [s3-bucket, lambda, ...]
https://github.com/rishikeshdarandale/website-deploy
npm npm-cli s3-website website-deploy
Last synced: 6 days ago
JSON representation
A simple utility to deploy a static website to [s3-bucket, lambda, ...]
- Host: GitHub
- URL: https://github.com/rishikeshdarandale/website-deploy
- Owner: RishikeshDarandale
- License: mit
- Created: 2018-08-23T07:13:33.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-08-28T09:17:25.000Z (over 1 year ago)
- Last Synced: 2024-12-08T19:25:07.941Z (about 1 month ago)
- Topics: npm, npm-cli, s3-website, website-deploy
- Language: JavaScript
- Homepage: https://rishikeshdarandale.github.io/website-deploy/
- Size: 1.42 MB
- Stars: 6
- Watchers: 4
- Forks: 1
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# website-deploy
A simple utility to deploy a static website to [s3-bucket, lambda, ...]
[](https://circleci.com/gh/RishikeshDarandale/website-deploy)
[](https://snyk.io/test/github/RishikeshDarandale/website-deploy)
[](https://www.codacy.com/app/RishikeshDarandale/website-deploy?utm_source=github.com&utm_medium=referral&utm_content=RishikeshDarandale/website-deploy&utm_campaign=Badge_Grade)
[](https://dependabot.com)
[](https://www.npmjs.com/package/website-deploy)
[](https://www.npmjs.com/package/website-deploy)
[](https://github.com/RishikeshDarandale/website-deploy/blob/master/LICENSE)
# Pre-requisite
**You need a node v8 or higher to run this utility.**
# Installation
## Install globally
```console
npm install --global website-deploy
```
## Install in project
```console
npm install --save-dev website-deploy
```
# Usage
This utility has following sub-commands:
## s3 deploy
This sub-command sync the provided source folder with AWS s3 bucket.
```console
website-deploy s3 [options]
```
### Options
`--delete`
This will delete all the files from the AWS s3 bucket which are not present in provided
`--debug`
This will print extra debug statements for more visibility
`--profile `
Provide a AWS credential profile as a credentials.
`--region `
Provide a AWS region Name. Default is `us-east-1`.
## lambda deploy
This will deploy your application deployable file to AWS lambda.
### update
Deploy/update a new function code.
```console
website-deploy lambda update [options]
```
`--debug`
This will print extra debug statements for more visibility
`--profile `
Provide a AWS credential profile as a credentials.
`--region `
Provide a AWS region Name. Default is `us-east-1`.
### version
Get the versions deployed to function.
```console
website-deploy lambda version [options]
```
`--count [count]`
This will display the maximum version specified by count. Default is `10`.
`--debug`
This will print extra debug statements for more visibility
`--profile `
Provide a AWS credential profile as a credentials.
`--region `
Provide a AWS region Name. Default is `us-east-1`.
### build
Create the lambda deploable zip file
```console
website-deploy lambda build [options]
```
`--path `
A object path to be invalidated. This can be provided multiple times to specify additional paths.
e.g.
```console
website-deploy lambda build --path "/index.js" --path "/lambda.js" myapp.zip
```
`--include-node-modules`
Include the `production` npm packages. This will need `package-lock.json`
`--debug`
This will print extra debug statements for more visibility
## invalidate-cache
This sub-command will invalidate the cloudfront cache
```console
website-deploy invalidate-cache [options]
```
### Options
`--path `
A object path to be invalidated. This can be provided multiple times to specify additional paths.
e.g.
```console
website-deploy invalidate-cache --path "/index.html" --path "/error.html"
```
`--debug [true|false]`
This will print extra debug statements for more visibility
`--profile `
Provide a AWS credential profile as a credentials.
`--region `
Provide a AWS region Name. Default is `us-east-1`.
# Issue or need a new feature?
If you are experiencing a issue or wanted to add a new feature, please create a github issue [here][1].
# Contributing
:star: Star me on GitHub — it helps!
:heart: contribution: Here is [contributing guide][2] in deatil.
For impatient here are quick steps:
- **Fork** the repository
- Create **Branch** in you local repository
- while(youFinish) { **Commit** }
- **Squash** related commits.
- **Write** unit test cases for your work.
- Check the **Build** on your local.
- Raise a **Pull Request** (aka PR)
[1]: https://github.com/RishikeshDarandale/website-deploy/issues/new
[2]: ./CONTRIBUTING.md