dynamodb-docs v0.0.2

dynamodb-docs

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Installing

Install the latest stable version with npm

npm install -g dynamodb-docs

Usage

The program is executed on the command line.

For help on how to use the program:

dynamodb-docs -h

dynamodb doc format

The program uses dynamodb docs to understand how your dynamodb tables would look like. They are simple json files with the format as below.

{
  "columname1": {
    "type": "String"
  },
  "columname2": {
    "type": "Number"
  },
  "columname3": {
    "type": "Boolean"
  },
  "columname4": {
    "type": "List",
    "dataType": "String"
  },
  "columname5": {
    "type": "List",
    "object": {
      "key1": {
        "type": "String"
      },
      "key2": {
        "type": "Number"
      },
      "key3": {
        "type": "List",
        "dataType": "Number"
      }
    }
  }
}

The above json would result in the following example document by running: dynamodb-docs example filename

{
  "columname1": "",
  "columname2": 0,
  "columname3": false,
  "columname4": [""],
  "columname5": [
    {
      "key1": "",
      "key2": 0,
      "key3": [0]
    }
  ]
}

Running the tests

We use Ava for running unit tests. For styling we use XO

npm test

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the MIT License - see the LICENSE file for details