HRDC User Docs

HRDC Inventory System

Product Overview

This project is an inventory management system for the HRDC Warming Hut in Bozeman, Montana. Our system helps:

Installation Guide

To obtain and install the software, follow these steps:

  1. Install Docker Desktop, which includes Docker and Docker Desktop.
  2. Ensure you have a .env file in the project's base directory.
  3. Linux:
    make build
  4. Windows:
    docker-compose --env-file .env -f compose.yaml build
  5. Deployment is automated via a CI/CD pipeline. Any commits to the main branch will trigger a deployment to the NorthFlank web server.

Running the Software

Before running the software, ensure Docker is installed and that a .env file exists in the base directory.

  • Linux: Pull the latest changes from GitHub, run make build, then make dev. If a .env file does not exist, create one using touch .env.
  • Windows: If Makefile tools are unavailable, use docker-compose --env-file .env -f compose.yaml build to build and docker-compose --env-file .env -f compose.yaml up to run. If a .env file does not exist, create one using New-Item .env.
  • Note: Older versions of Docker use "docker compose" instead of "docker-compose"; update commands accordingly.

Using the Software

The website consists of two main parts: the login page and the homepage, which displays a table of all inventory items.

Admin users can add and delete items. Each item includes:

  • Name and description
  • Minimum and current count
  • Status and location
  • Category and price

Additional features include:

  • Analytics page with item usage metrics
  • User settings page
  • Notification center for stock alerts

Access the system at: HRDC Inventory System

Reporting Issues

Bugs should be reported via GitHub Issues using templates found here. Issues should include:
  • Expected behavior
  • Current behavior
  • Possible solutions
  • Reproduction steps
  • Environment details

Current Features

  • Comprehensive inventory table displaying all item details
  • Sortable and searchable table interface
  • Admin controls for inventory management (add/edit/delete)
  • Analytics dashboard with inventory trends and pie chart of item proportions
  • Notification system for low stock alerts in the navbar
  • Downloadable table data into csv format
  • User authentication and role-based access