boweihan / iot-app-kit-1

IoT Application Kit

To get started with the IoT Application Kit and the AWS IoT SiteWise source, see Getting Started.

To learn more about IoT Application Kit components, sources, and the core API see docs.

Quick start for development

1. Environment setup

Ensure you have node version 16 and the latest version of yarn installed.

To do this, execute the following commands:

# Install `n`, a node package manager, globally to help switch between node versions.
npm i n -g

# Update to node version 16
sudo n 16

# Install the latest version of yarn
npm i yarn@latest -g

# Optionally, install lerna
npm i lerna -g

2. Build project

# Without installing lerna locally...
npx lerna bootstrap

# With lerna installed locally
lerna bootstrap

4. Provide credentials Copy a set of AWS JSON formatted credentials to the account with the access to the SiteWise resources you are requesting, at <rootDir>/packages/components/creds.json.

These credentials should not be uploaded to the repository.

5. Point to valid SiteWise resources

Alter the file siteWiseQueries within @iot-app-kit/components to point to valid SiteWise asset properties for the accounts credentials from the prior step.

3. Test locally run yarn run start at the project root, and then view localhost:3333. Here you should see example IoT App Kit components requesting data from SiteWise.

Packages

The IoT Application Kit mono-repo containing the following packages:

@iot-app-kit/core

@iot-app-kit/core is the core library which exposes the iot-app-kit framework, and is what iot-app-kit components are built upon.

Learn more here.

@iot-app-kit/components

@iot-app-kit/components is a collection of web components which are connected to iot-app-kit.

Learn more here.

@iot-app-kit/react-components

@iot-app-kit/react-components exposes the core iot-app-kit web components as React components.

Learn more here.

@iot-app-kit/source-iotsitewise

@iot-app-kit/source-iotsitewise exposes the AWS IoT SiteWise source, which enables you to visualize and interact with your AWS IoT SiteWise data and assets.

Learn more here.

@iot-app-kit/related-table

@iot-app-kit/related-table is a tree view table component built over @awsui/components-react components providing client-side filtering, sorting and pagination with highly performant and optimistic rendering.

Learn more here.

Security

See CONTRIBUTING for more information.

License

This project is licensed under the Apache-2.0 License.