UTDallasEPICS / utd-oos-bottle-counter

2 stars 1 forks source link

UTD Office of Sustainability Water Bottle Counter

This repository contains the code for the UTD Office of Sustainability Water Bottle Counter EPICS project. The website folder contains the API, database, and web front end. The microcontroller folder contains the code used with a microcontroller as the interface between the water fountains and the web server (API).

The Water Bottle Counter works to retrieve data from arduinos retrofitted into water fountains around campus, and provides a variety of different functions for interacting with the data that was retrieved.

Installation

Use the package manager npm to install required dependencies.

cd website
npm i

Change the .env.example to just .env

Usage

cd website

# start website
npm run dev

Navigate to the resulting website, usually at http://localhost:3000

Features

Website Tech Stack

This is a fullstack application built in the Next.js framework. The database is a simple SQLite schema, connected to our application via a prisma connection. We used postman to test the application's API routes that affect the database, including the increment API used by the arduinos.

Deployment

Not deployed yet, but will eventually be hosted on Office of Sustainability site, maybe the EPICS server.