Skip to content
This repository has been archived by the owner on Mar 6, 2020. It is now read-only.

Latest commit

 

History

History
59 lines (40 loc) · 2.01 KB

README.md

File metadata and controls

59 lines (40 loc) · 2.01 KB

DKT.flows-engine

Requirements

Node

All the tools and Scripts are written in JavaScript (>ES6). This means you have to install Node. We Support every Node Version >= 8.9.0. (since this is the latest Long-term Support Version).
You can install node via NVM, Homebrew (on macOS) or you download a installer from nodejs.org/.

  • NVM: nvm install 8.9.0 (recommended)
  • brew: brew install node

When you have to change the node version from time to time (e.g. for different projects) then you can run $ nvm use when entering the project directory. This will select the node version defined within the .nvmrc file. Or you add this code snipped (link) to your .zshrc or .bashrc.

AWS

If you want to interact with AWS (deploying, ... etc.) then you have to define a named Profile [DKT] within your ~/.aws/credentials file.

[DKT]
aws_access_key_id = <yourAccessKey>
aws_secret_access_key = <yourSecretAccessKey>

Command line tool cli/dkt

This Project comes with a small command line tool to build, bundle, test and deploy the flow-engine stack and StepFunctions!

Usage: cli/dkt [options] [command]


  Commands:

    stack [command]          deploy stack
    stepfunctions [command]  start step functions
    test [command]           run tests
    help [cmd]               display help for [cmd]

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

Development

Testing

Deployment