walkthrough.md

RIMS - React Inventory Management System

A comprehensive walkthrough of the RIMS application features.

Table of Contents

• Getting Started
• Inventory Management
• Item Templates
• Bill of Materials (BOM)
• Reports & Analytics
• Data Import & Export
• Barcode & Labels
• Keyboard Shortcuts
• Dark Mode
• User Management

---

Getting Started

Welcome Page

The landing page introduces RIMS and its key features. Users can sign up or log in to access the inventory system.

Login

Secure authentication with email and password. Default credentials for demo:

• Admin: admin@example.com / changeme
• User: user@example.com / changeme

---

Inventory Management

Item List

The main inventory view with powerful features:

• Search: Full-text search across all item fields
• Filters: Filter by category and location
• Sorting: Click column headers to sort
• Pagination: Navigate through large inventories
• Bulk Actions: Select multiple items for batch operations

Search

Quickly find items with instant search. Results filter as you type across name, description, part numbers, and more.

Bulk Selection

Select multiple items using checkboxes for batch operations:

• Delete multiple items at once
• Change category for selected items
• Export selected items

New Item Form

Create new inventory items with comprehensive fields:

• Template Selection: Use pre-defined templates to speed up data entry
• Image Upload: Automatic compression for images over 100KB
• Vendor Lookup: Look up prices from supported vendors (Adafruit, DigiKey, Mouser, etc.)
• Barcode: Assign barcodes for scanning
• Reorder Point: Set low stock alerts

Item Detail

View complete item information including:

• Cost History Chart: Visual tracking of price changes over time
• Vendor Price Comparison: Compare prices across multiple vendors
• Stock Status: Reorder alerts when quantity falls below threshold

---

Item Templates

Create reusable templates to speed up item entry. Templates store default values for:

• Category
• Vendor name and URL
• Location
• Reorder point
• Description

Perfect for adding multiple items from the same vendor or category.

---

Bill of Materials (BOM)

BOM List

Group items into projects or assemblies. Each BOM shows:

• Total component count
• Calculated total cost
• Build availability status

Create BOM

Build a bill of materials by:

1. Adding a name and description
2. Selecting items from your inventory
3. Specifying quantities needed
4. Adding notes for each component

The form automatically calculates line totals and overall cost.

---

Reports & Analytics

Dashboard

Get a high-level overview of your inventory:

• Total items and value
• Category breakdown charts
• Low stock alerts
• Recent activity

Inventory Valuation

Detailed valuation report showing:

• Value by category
• Top valuable items
• Total inventory worth

Stock Movement

Track inventory changes over time:

• Items added/removed
• Quantity adjustments
• Historical trends

Custom Reports

Build your own reports with:

• Flexible column selection
• Custom filters
• Export to CSV/JSON

---

Data Import & Export

Reorder Alerts

Monitor items that need restocking:

• Items below reorder point
• Quick reorder actions
• Configurable thresholds

Data Import

Import inventory from CSV files:

• Field mapping interface
• Preview before import
• Validation and error handling

---

Barcode & Labels

Print Labels

Generate printable labels for your inventory:

• Multiple label formats
• Barcode generation
• Batch printing

Barcode Scanner

Scan barcodes using your device camera:

• Quick item lookup
• Add scanned items to inventory
• Mobile-friendly interface

---

Keyboard Shortcuts

Power users can navigate quickly with keyboard shortcuts:

Key	Action
?	Show keyboard shortcuts
n	Create new item
/ or Ctrl+K	Focus search
i	Go to inventory
h	Go to home
r	Go to reports
b	Go to BOMs
Escape	Close modal / blur input

---

Dark Mode

RIMS supports dark mode for comfortable viewing in low-light environments. Toggle the theme using the sun/moon icon in the header.

Item List - Dark Mode

Dashboard - Dark Mode

Item Detail - Dark Mode

---

User Management

Administrators can manage users:

• View all registered users
• Change user roles (user, vip, admin)
• Monitor sign-in activity

---

Technical Features

Progressive Web App (PWA)

RIMS is a PWA, meaning you can:

• Install it on your device
• Use it offline
• Get a native app-like experience

Local Storage

All data is stored in your browser's localStorage:

• No server required
• Data stays on your device
• Export/import for backup

Image Optimization

Images are automatically compressed:

• Max width: 800px
• JPEG quality: 70%
• Target size: under 100KB

---

Getting Help

• Press ? for keyboard shortcuts
• Check the GitHub repository for issues and updates
• Default login: admin@example.com / changeme