/dynamoose-example

Illustrates how to talk to DynamoDB using the Dynamoose Library

Primary LanguageTypeScript

Description

This repository contains an example on how to use the Dynamoose library (https://dynamoosejs.com/getting_started/Introduction) to communicate with DynamoDB.

Illustration

The diagram below illustrates the different components and how they interact with each other:

Diagram

Setup

  1. Setup AWS & Serverless, make sure you have an .aws directory in your user home folder that contains your credentials and config.

  2. Duplicate the .env.template file based on the stage and set the variable values:

    cp .env.template .env.<stage>
vim .env.<stage>

    for example:

    cp .env.template .env.personal
vim .env.personal

  3. Install dependencies in the root folder:

    npm i

  4. Install dependencies for each app in the apps folder:

    cd apps/<app_name>
npm i

    for example:

    cd apps/comments
npm i

Deploying the Database to AWS

  1. Run the following command: 
    npm run deploy --stage=<stage> --application=db
    for example: 
    npm run deploy --stage=personal --application=db

Running a Single Application Locally

  1. Go to the apps folder and run the following command: 
    cd apps/<app_name>
npm run dev --stage=<stage>
    for example: 
    cd apps/comments
npm run dev --stage=personal

Links