/aquagas-monitor

AquaGas Monitor is an innovative service designed to streamline the individual tracking and management of water and gas consumption. Using Overnight(Node/express), Typescript, Prisma, Postgress and Docker

Primary LanguageTypeScript

AquaGas Monitor

Table of Contents

Overview

The back-end of a service that manages individual readings for water and gas consumption will leverage AI to obtain measurements from photos of meters. This approach will facilitate the accurate collection of data by utilizing advanced image recognition technology to interpret the meter readings.

Overview For Windows

It is EXTREMELY important to run this project in a Linux environment. If you are using Windows, please follow the steps below.

  1. Open your wait-for-it.sh alt text

  2. Select the type of your file (in windows should be CRLF) alt text

  3. Change to LF, save file, and follow the below instructions alt text

api-doc: https://www.postman.com/science-geoscientist-88101143/workspace/aquagas-doc/collection/37958244-aafa432e-6bb4-4df2-9696-b8075ce9e8d8?action=share&creator=37958244&active-environment=37958244-9d9a5ea5-b99e-46f5-8e4f-99dbc859def9

Installation

  1. Clone the repository:

     git clone git@github.com:voibhiv/aquagas-monitor.git

  2. Navigate to the project directory:

     cd aquagas-monitor

  3. Create an .env file and add your secret key:

     GEMINI_API_KEY='your-secret-key'

    you can get an api-key here: https://ai.google.dev/gemini-api/docs/api-key

  4. Run the containers using Docker:

     docker compose up --build