Ekko is a realtime serverless framework. Use the ekko-realtime-cli to initialize the Ekko framework and manage serverless functions for your realtime application.

Usage

$ npm install -g ekko-realtime-cli
$ ekko COMMAND
running command...
$ ekko (-v|--version|version)
ekko-realtime-cli/0.0.30 darwin-x64 node-v14.15.0
$ ekko --help [COMMAND]
USAGE
  $ ekko COMMAND
...

Getting Started

Prerequisites

• an AWS account
• npm is installed
• the AWS CLI is installed and configured
• the AWS CDK command-line tool is installed

Installation

• run npm install -g ekko-realtime-cli (to install our npm package)
• type ekko --help to see the commands available to use

First Time Usage

The ekko command is run by inputting commands after the initial ekko like: ekko <command> <optional argument>.

To read the help text for each command, type ekko <command> --help. This will output a short explanation of what the command does, which arguments it takes and how to use it.

• cd to the folder in which you would like to initialise your Ekko directory
• type ekko init:
• type y to deploy a new Ekko infrastructure which will:
  • setup your AWS credentials for Ekko
  • deploy Ekko infrastructure to AWS
  • create an Ekko skeleton folder and file framework for your project files in the current directory
• type n to join and existing Ekko infrastructure
  • you will be prompted for your organizations Ekko infrastructure information which can be found in ~/.ekko/.env on a machine where Ekko has been initialized:
    • SECRET
    • API_ENDPOINT
    • S3_BUCKET
    • LAMBDA_ROLE_ARN
  • you will then be prompted for your AWS credentials
    • AWS_ACCESS_KEY_ID
    • AWS_SECRET_KEY
    • AWS_REGION
  • this creates a an Ekko folder in your current directory containing an empty ekko_apps folder
  • clone your organization’s Ekko application repositories in the ekko_apps folder
  • clone your organizations’s ekko_functions repository in the Ekko folder