Shopping List Quick Start - Web

This Quick Start uses a familiar concept - a shared Shopping List - to demonstrate how to create and use a Vendia Share Universal Application (Uni).

This Quick Start uses the Vendia Share Web Application to create the Uni that will be used in this Quick Start. Alternatively, the Shopping List Quick Start - CLI can be followed if you prefer a command-line over a visual interface.

Login to Vendia Share

The first step to using the web application for deploying our Shopping List Uni is to log in to the Vendia Share web application. If you don’t yet have a user account for Vendia Share you will first need to sign up. If you have an account but have forgotten your password, you can reset it.

Once you’re logged in, you can click on the “Create an application” button to Create a Uni.

Define Your Uni

Provide the requested information in the following steps.

Name Your Uni

NOTE: Pick a unique name for your Uni that begins with test- - by default all Unis share a common namespace, so here is your chance to get creative.

Define Your Node Attributes

We can define our node attributes. In this example, we are deploying 4 nodes. In our demo, each node is defined in AWS’ us-west-2 region, but in practice, each node could be deployed in any of Vendia’s supported regions. Please refer to our Frequently asked questions page for more information.

NOTE: Starter tier users may need to configure fewer nodes than shown given the node limits enforced. See full details on the Pricing page.

Once we’ve configured our node settings, click the ‘Next’ button to proceed.

Design Your Data Model/Schema

When we create a Uni, we have the option to start with pre-defined schemas or use our own. For this Quick Start, we will use the JSON editor and provide the same JSON schema used in the CLI version of the current Quick Start.

Click Next to proceed.

Provide JSON for Schema

Enter the following JSON schema in the JSON editor and click ‘Next’.

Note: Make sure to overwrite the existing contents in the JSON editor with the following JSON schema

Expand This Section for the Schema JSON to Use in Next Step

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "http://vendia.com/schemas/demos/shopping-list.json",
  "title": "Shopping List",
  "description": "Store shopping list data",
  "x-vendia-acls": {
    "ShoppingListAcl": {
      "type": "ShoppingList"
    }
  },
  "type": "object",
  "properties": {
    "ShoppingList": {
      "description": "Items on the shopping list",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "item": {
            "description": "What to buy",
            "type": "string"
          },
          "quantity": {
            "description": "How much to buy",
            "type": "string"
          },
          "recommendedLocation": {
            "description": "Where I should buy",
            "type": "string"
          },
          "bought": {
            "description": "Whether it has been bought",
            "type": "boolean"
          },
          "timestampAdded": {
            "description": "When the item was added",
            "type": "string",
            "format": "date-time"
          },
          "timestampPurchased": {
            "description": "When the item was purchased",
            "type": "string",
            "format": "date-time"
          }
        },
        "required": ["item"]
      }
    }
  }
}

Invite Partners (Skip for Now)

You can skip this step for now.

Click Finish to complete the Uni creation process.

Node Deployment

At this point, you will see the nodes in your Uni begin to deploy. You may need to refresh the page to determine when your Uni is running.

After deployment is completed, you will be brought to the following view:

Add Data to Uni

Click on the Data tab in the previous view and you will see that your Uni currently does not have any data.

You can add data to your Uni by using the following sample data.

Click to View Sample Shopping List Initial Data

Use the following initial state data for our Uni.

CSV:

item,quantity,recommendedLocation,bought,timestampAdded
Bread,1 loaf,Best Bakery,false,2020-12-05T18:43:54Z
Cheese,2 lb,Cheesy Charlies,false,2020-12-05T14:23:32Z

JSON:

{
  "ShoppingList": [
    {
      "item": "Bread",
      "quantity": "1 loaf",
      "recommendedLocation": "Best Bakery",
      "bought": false,
      "timestampAdded": "2020-12-05T18:43:54Z"
    },
    {
      "item": "Cheese",
      "quantity": "2 lb",
      "recommendedLocation": "Cheesy Charlies",
      "bought": false,
      "timestampAdded": "2020-12-05T14:23:32Z"
    }
  ]
}

Once the Uni is running we can use our Uni.