SaltyDog UI

This is the user interface software for a salinity sensor system that tracks EC, PH, and DO levels in nutrient saltwater used in an Heron Farms indoor farm. It Uses Atlas Scientific sensors and communicates through wifi to an AWS IoT core where it transmits data to aurora DB through event actions. This User interface uses React and Apollo GraphQL utilizing Prisma with an Express Server that utilizes a PG Database instance with Timescale DB organizing the time series data. In deployment the DB is replaced with an AWS aurora DB instance with data coming from an AWS IoT Thing action.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Built With

• React
• GraphQL
• TypeScript
• Prisma
• PostgresQL
• Express

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Node.js 14+ required

• npm

npm install

Installation

1. Clone the repo

git clone https://github.com/bohemus307/SaltyDogUI.git

2. Install NPM packages

npm install

Usage

Info for setting up prisma

Prisma Docs

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - Email - email

Project Link: "https://github.com/bohemus307/SaltyDogUI"

Acknowledgements