Hydrafacial AWS IOT

Hydrafacial AWS IOT Infrastructure

Status GitHub Issues GitHub Pull Requests License



HydraFacial is connecting the data from its facial treatment systems to the AWS cloud.

📝 Table of Contents

🧐 About

This project will develop the IoT cloud connection and required infrastructure for AWS IOT services.

Collected data from IOT devices will then be utilized to support key metrics and use cases for its business, providers, and end users.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them.

Node Package Manager NPM
AWS Credentials
@onica/Runway

Installing

A step by step series that tell you how to get a development env running.

Installing Runway can be offered with different options but here it will be available as dev dependency in the package.json , so you will just need to run this command:

npm install

🔧 Running the tests

Explain how to run the automated tests for this system.

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

🎈 Usage

Add notes about how to use the system.

🚀 Deployment

This project use runway to manage deployment of Cloudformation stacks on different environments as follows:

npx runway deploy --debug --deploy-environment dev

npx runway deploy --debug --deploy-environment stage

And for generating sample Cloudformation module :

npx runway gen-sample cfn

⛏️ Built Using

  • Runway - IAC Deployment Tool
  • NPM - Node Package Manager

✍️ Authors

🎉 Acknowledgements

  • Hat tip to anyone whose code was used
  • Inspiration
  • References