Home

Xuchil

Welcome to the Xuchil wiki!

Conceptual Overview

The purpose of Xuchil is to

• Provide a view of the inventory and production activities
• Add and remove inventory based off of incoming shipments and delivieries
• Track and record production times that provide into how much each worker works

Functional Requirements

User Authentication

• Secure login with username and password
• Role-based access (e.g. worker, manager)
• Session persistence for active users

Time Tracking

• Start and stop timers for specific tasks or product batches
• Manual time starts, pauses, and ends for each task
• Associate time logs with specific users and products
• View summaries of time worked per day/week/batch

Inventory Management

• Display current inventory levels for materials and finished products
• Set minimum thresholds to keep the product/material quantity above
• Update with outgoing deliveries, changes, etc.

Order Management

• List current production orders and their statuses
• View detailed history of fulfilled orders
• Add new customer or internal orders to the system
• Track order fulfillment progress and completion dates

Users/Roles

Worker

• Manage inventory
• Log products worked on
• Log time worked
• Check out batch post completion

Manager

• Can check how much time each worker worked
• Admin privileges ~ add/remove workers
• Calculate pay for each worker
• Manage inventory
• Log products worked on
• Log time worked
• Check out batch post completion

User Workflows

Worker Workflow

1. Log In

   • Enter username and password

2. Start Work

   • Select a product or batch to work on
   • Start timer when beginning product and end timer upon completion

3. Manage Inventory

   • Update material/product quantities based on usage

4. Log Product Details

   • Record which product was worked on
   • Submit any relevant batch information

5. Check Out

   • End the current work session
   • Finalize and log time worked on batch

6. Edit account

   • Allow the user to view and edit their account details

Manager Workflow

1. Log In

   • Enter admin credentials

2. Manage Users

   • Add or remove workers
   • Assign roles and permissions

3. Review Worker Logs

   • View time logs per worker, per product, or per date
   • Generate reports or export summaries for payroll
   • Calculate and approve final pay

4. Inventory Oversight

   • View all inventory data
   • Set minimum thresholds

5. Order Management

   • Add new production or customer orders
   • Monitor fulfillment progress
   • Review order history

Third Party Integrations

• N/A ~ this application is for internal use only

Tech Stack

• Frontend/Backend - Next.js
• Database - SQLite and Prisma
• Backend Testing - Postman

Deployment Notes

• When this project is ready to be deployed it will be deployed on Xuchil's local server