amaui AWS

AWS

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

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

Getting started

Add

1  yarn add @amaui/aws

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

1  yarn add @aws-sdk/client-s3

Use

1  import AmauiAws from '@amaui/aws';
2
3  // Make if you wanna a config file and
4  // inside of it add all the process.env related props
5  import Config from './config';
6
7  // Make a new aws instance
8  const amauiAws = new AmauiAws({
9    s3: {
10      bucketName: Config.aws.s3.bucketName,
11
12      credentials: {
13        accessKeyId: Config.aws.s3.accessKeyId,
14        secretAccessKey: Config.aws.s3.secretAccessKey
15      },
16
17      endpoint: Config.aws.s3.endpoint,
18
19      region: Config.aws.s3.region
20    }
21  });
22
23  // Add
24  await amauiAws.s3.add('a', 4);
25
26  // Get
27  await amauiAws.s3.get('a');
28
29  // 4
30
31  // Remove
32  await amauiAws.s3.remove('a');
33
34  await amauiAws.s3.get('a');
35
36  // undefined

Dev

Install

1  yarn

Test

1  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

1  yarn docker

Prod

Build

1  yarn build