Comet Cupboard: Inventory Tracking

Project Overview

The purpose of the Comet Cupboard Inventory Tracking is to

• Provide a streamlined view of the inventory of the food pantry
• Facilitate add/removal of inventory items through restocking and cart checkout
• Provide analytics for the admin about useful statistics such as Comet Cupboard weekly usage or most popular items in a week

Documentation

Refer to overall and semester documentation in GitHub Wiki

Setting Up Development Environment

Ensure Node.js, npm, Visual Studio Code, Git are installed. Ensure that everyone is working on the latest Long-Term-Support (LTS) Node.js version.

Usually, you can get away with using Git Bash (on its own or within VS Code) as your terminal.

Install pnpm as your package manager

npm install -g pnpm

Install the repo

git clone https://github.com/UTDallasEPICS/Comet-Cupboard.git
cd Comet-Cupboard
pnpm install

Set up environment variables

# Fill out the environment variables accordingly
cp .env.example .env

Database Setup

# Initialize the database and test data seeding
pnpm run dev-prisma

Running the Application

pnpm run dev

Useful Dev Tips

Prettier Formatting

pnpm run format

Prisma

# Prisma GUI to view database
pnpm dlx prisma studio

Postman

Use Postman to test HTTP, SSE, and WebSockets. Keep in mind that some features like SSE do not work on the Postman extension for VSCode, so have the Postman desktop app for full functionality.

Deployment Notes

N/A

Migration Scripts

N/A