npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@team-supercharge/cloud-website-deployer

v1.0.5

Published

Deploy static websites to S3, set caching rules and invalidate CloudFront Distribution

Downloads

5

Readme

Deploy static websites to S3 bucket

Deploy static websites to S3, set caching rules and invalidate CloudFront Distribution.
You can use this tool for upload files to an S3 folder with the right mime types based on the extension of the file.
The CloudFront Distribution cache will be invalidated after the upload.
Also you can set caching rules for individual files or folders.
Caching rules are read from top to bottom. The first hit will be applied.
E.g. you want to cache just example.css file in the css folder you need to set first the caching role for example.css and then set no-cache for the css folder.

Install:
npm install -g @team-supercharge/cloud-website-deployer

To run use the cwd command

Create a config JSON file for configuration.

Example config:

{
    "useAWSCredentialsFromEnv": true,
    "awsProfile": "",
    "bucketName": "my-website",
    "emptyBucket": true,
    "bucketRegion": "eu-central-1",
    "webFolder": "build/website/",
    "cloudFrontID": "1234567890ABCD",
    "cloudFrontDefaultCacheControl": "no-cache",
    "cloudFrontInvalidationPaths": [
        "/*"
    ],
    "cloudFrontCacheRules": [{
        "path": "index.html",
        "cacheControl": "no-cache"
    },
    {
        "path": "assets/*.jpg",
        "cacheControl": "max-age=604800"
    },
    {
        "path": "/assets/*",
        "cacheControl": "max-age=2592000"
    },
    {
        "path": "/favicon.ico",
        "cacheControl": "no-cache"
    },
    {
        "path": "*.js",
        "cacheControl": "max-age=2592000"
    },
    {
        "path": "css/*.scss",
        "cacheControl": "no-cache"
    }]
}

Also you can use the following env variables

AWS_ACCESS_KEY_ID - Your AWS access key ID.
AWS_SECRET_ACCESS_KEY - Your AWS access key secret.
AWS_PROFILE - Your AWS profile.
AWS_DEPLOY_CONFIG_FILE - String: Path to the configuration file.
AWS_DEPLOY_BUCKET_NAME - String: The name of the bucket where you want to upload the static site files.
AWS_DEPLOY_BUCKET_REGION - String: The AWS region of the S3 bucket. (e.g.: us-east-1)
AWS_DEPLOY_WEB_FOLDER - String: Path to static site's folder
AWS_DEPLOY_EMPTY_BUCKET - Bool: Empty the S3 bucket before upload.
AWS_DEPLOY_CLOUDFRONT_ID - String: The ID of the CloudFront Distribution.
AWS_DEPLOY_CLOUDFRONT_INVALIDATION_PATHS - Array: The paths for the cloudfront invalidation

Default values:

cloudFrontDefaultCacheControl - "no-cache"
cloudFrontInvalidationPaths - [ "/*" ]

config.cloudFrontCacheRules if the only value which has to be set in configuration file.