amaui AWS

AWS

_{MIT license     Production ready     100% test cov     Nodejs}

_{Very simple code     Modern code     Junior friendly     Typescript     Made with 💛}

Getting started

Add

yarn add @amaui/aws

Add @aws-sdk/client-s3 peer dependency.

yarn add @aws-sdk/client-s3

Use

  import AmauiAws from '@amaui/aws';

  // Make if you wanna a config file and
  // inside of it add all the process.env related props
  import Config from './config';

  // Make a new aws instance
  const amauiAws = new AmauiAws({
    s3: {
      bucketName: Config.aws.s3.bucketName,

      credentials: {
        accessKeyId: Config.aws.s3.accessKeyId,
        secretAccessKey: Config.aws.s3.secretAccessKey
      },

      endpoint: Config.aws.s3.endpoint,

      region: Config.aws.s3.region
    }
  });

  // Add
  await amauiAws.s3.add('a', 4);

  // Get
  await amauiAws.s3.get('a');

  // 4

  // Remove
  await amauiAws.s3.remove('a');

  await amauiAws.s3.get('a');

  // undefined

Dev

Install

yarn

Test

yarn test

One time local setup

Install docker and docker-compose

• https://docs.docker.com/get-docker
• https://docs.docker.com/compose/install

Install aws

• https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html

Make docker containers

yarn docker

Prod

Build

yarn build