/Leo

Leo Platform

Primary LanguageJavaScriptMIT LicenseMIT

Leo Platform Quick Start Guide

Step 1: Install required 3rd party tools

  1. Install the aws-cli toolkit
  2. Configure the aws-cli tools
  3. Install node

Step 2: Install the LEO Platform

Notes:

In the following steps, make sure you have selected either “US West (Oregon)” or “US East (N. Virginia)” as your region in AWS. Those are the only two supported regions.

Install the Leo Platform stack
  1. Make sure your selected region is one of: US West (Oregon) or US East (N. Virginia).
  2. Go to CloudFormation
  3. Click “Create Stack”
  4. Paste this cloudformation link (https://leo-cli-publishbucket-abb4i613j9y9.s3.amazonaws.com/leo/2.0.0/cloudformation-1652216325999.json) into the “Specify an Amazon S3 template URL” field and click “Next”.
  5. Specify a stack name (e.g. LeoPlatformDev, LeoPlatformStage) in the “Stack name” input field.
  6. Leave the Identity Pool ID blank. (In the future, we will support using an existing cognito pool. If you use an existing one here, you will have to manually setup auth roles).
  7. Fill out the Logins
  8. On the Options page, Click “Next”.
  9. Select the checkmark that says: “I acknowledge that AWS CloudFormation might create IAM resources.”, then click “Create”.
  10. Done. It will take several (5-10) minutes for the stacks to be created.

Step 3: Create a “quickstart” project

In your command line:

  1. Install the LEO CLI: npm install leo-cli -g
  2. Create a new project with the LEO CLI Quickstart: leo-cli create quickstart <projectName>

Step 4: Test your new project

Browse to the bots/sampleload directory in your new project and run a test.

  1. cd <projectName>
  2. cd bots/sampleload
  3. npm test

Step 5: Get the URL for Botmon

  1. In AWS, Go to API Gateway
  2. Click on the link for the botmon for your stack. It will be formatted like this: <stack_name>-Botmon-<random_chars>
  3. In the left-side navigation panel, click on “Dashboard”.
  4. The page that loads will have a link at the top. The link for Botmon will say: Invoke this API at:

Entities and Aggregations

From a microservice, run: leo-cli create aggregations. 4 bots and a cloudformation will be created that run from the bots created in the quickstart above. Documentation for Entities and Aggregation bots can be found here: https://github.com/LeoPlatform/connectors/tree/master/entity-table

Support

Want to hire an expert, or need technical support? Reach out to the Leo team: https://leoinsights.com/contact