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

@supercoder.dev/replace-local-files-with-aws

v1.0.0

Published

NodeJS-based Typescript application which provides functionality to replace local files with corresponding files on AWS S3 bucket.

Downloads

3

Readme

Replace local files with AWS

NodeJS-based Typescript application which provides functionality to replace local files with corresponding files on AWS S3 bucket.

Installation

NodeJS version 14.18.1 is required to work with this application.

Install all dependencies:

npm install

Provide environmental variables for AWS to .env file:

  • S3_BUCKET_NAME
  • AWS_ACCESS_KEY_ID
  • AWS_SECRET_ACCESS_KEY
  • AWS_REGION

S3_BUCKET_NAME

S3 bucket where replacement files are located

AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY

These are the AWS environment variables. They might be obtained in IAM services and/or in local AWS profile which is used for aws-cli.

AWS_REGION

AWS region where the S3 bucket was created.

Input configuration

To specify what files should be replaced with corresponding files in S3 bucket, you must create a JSON file according to the following governance:

{
  "config": [
    {
      "fileToReplace": "a.text",
      "keyOfFileToReplaceWith": "replace-from-aws-a.txt"
    }
  ]
}

When you start the program, you must provide the file's path. Continue reading to learn how.

fileToReplace

This is the path to the file that should be replaced with a file from the S3 bucket.

keyOfFileToReplaceWith

This is the key of an object inside an AWS S3 bucket.

Running from the command line

To start file replacement the following command should be launched:

npm run start

TS compiles code and then runs JS using NodeJS.

Tests

npm run test ./input.json

Here, ./input.json is the path to the configuration file. Replace this with your file's actual path. The command above runs Eslint (to check code for static issues) and then runs unit tests which are located in tests/units folder.