awslabs / iot-application

Visualize your AWS IoT data with the IoT Application.

IoT dashboard application built with IoT App Kit

The IoT dashboard application is an easy-to-use tool designed for businesses and individuals who need to keep track of their IoT devices and data. By creating and managing custom dashboards, you can effortlessly monitor your IoT devices and their data in real-time, connecting to your AWS IoT SiteWise data.

Whether you're in manufacturing, logistics, energy, or other industries relying on IoT devices, the application can help you address specific challenges such as tracking equipment performance, optimizing operational efficiency, and making data-driven decisions.

Built using IoT App Kit, a library that simplifies connecting your applications to AWS IoT, the application utilizes the AWS Cloud Development Kit (CDK) for a smooth deployment to AWS, ensuring a hassle-free setup process.

Key features of the application include:

• Dashboard management: Easily create, modify, view, and organize dashboards
• Dashboard customization: Design unique dashboards tailored to your specific IoT data requirements
• Intuitive interface: Enjoy a user-friendly drag-and-drop experience for creating dashboards
• Effortless deployment: Use the AWS CDK to deploy the application
• Secure authentication: Safeguard your application with AWS Cognito for user management and authentication

Start using the application today to quickly create, manage, and view your IoT data in real-time from assets in your AWS IoT SiteWise service. We encourage you to try the application, contribute to the project, and provide feedback to help us improve and enhance the application further.

Prerequisites

On most Unix systems including macOS, you can install the prerequisites with a single command:

./install-prepreqs-unix.sh

Alternatively, you can install the prerequisites by following the instruction below:

1. Install Volta using the environment specific commands listed below
   • Unix based environments

     curl https://get.volta.sh | bash

     After installing Volta, if applicable, you may need to refresh your bash profile using source ~/.bashrc to use Volta commands
   • Windows environments
     • Download and run Windows installer here
2. Install Node.js@18 with Volta

   volta install node@18

3. Install Yarn with Volta

   volta install yarn

Getting Started with local development

1. Install Java Runtime Environment (JRE) version 11.x or newer
2. Install nest a global dependency for using the Nest CLI:

   yarn add global nest

3. Install application dependencies:

   yarn install

4. Update the variables AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, and AWS_SESSION_TOKEN under file apps/core/.env with your development AWS credentials.
5. Start development server:

   yarn dev

6. Application is available at URL: http://localhost:3000
7. Log in with local Cognito credentials found at apps/core/.cognito/db/us-west-2_h23TJjQR9.json

Running the tests locally

Run local test command yarn test to test the application. The command is "batteries included" - it has everything needed to run and test the application locally.

Updating generated types locally

Run yarn gen:types in root while yarn dev is running.

Deploying to AWS Cloud

Instructions are located here

Environments

Service Dependencies

The table below lists the service dependencies for different environments.

Category\Environments	Local Development	Local Test
Authentication	cognito-local	cognito-local
App API Database	dynamodb-local	dynamodb-local
App API Authorization	cognito-local	JWT generated from secret

Security

See CONTRIBUTING for more information.

License

This project is licensed under the Apache-2.0 License.