Documentation

Overview

Cattlemin is a Progressive Web App (PWA) that provides a modern, responsive interface for managing cattle records, tracking births, monitoring vaccinations, and organizing multiple locations. The application is built with a focus on usability, data integrity, and real-world agricultural workflows.

Key Features

• Multi-Location Management: Organize cattle across different locations with geolocation support
• Cattle Records: Track individual cattle with ear tags, age, and parent relationships
• Birth Records: Document new births with parent-calf relationships and birth types
• Vaccination Tracking: Monitor vaccination schedules and types (Black Leg, Respiratory, Lepto, Wormer)
• Real-time Updates: Instant data synchronization across the application
• Mobile-First Design: Responsive interface optimized for field use
• Data Validation: Robust form validation using Zod schemas
• Cloud Storage: Secure data storage with Cloudflare integration

Quick Start Guide

For a comprehensive step-by-step guide for new users, see our Complete User Guide.

Managing Locations

1. Create a Location

   • Navigate to the Locations dashboard
   • Click the “Location” button to open the creation dialog
   • Enter location name and optional geo-location
   • Add notes about the location

2. Edit Location Details

   • Select a location from the dashboard
   • Use the location settings to modify name, coordinates, or notes

Managing Cattle Records

1. Add Individual Cattle

   • Open a location
   • Click “Record” → “Cattle”
   • Enter ear tag number, age, type, and date of birth
   • Optionally link to parent cattle

2. Mass Entry Mode

   • Enable mass entry for bulk cattle registration
   • Add multiple cattle records without closing the form

3. Edit Cattle Records

   • Click on any cattle card to edit details
   • Update tag numbers, age, or parent relationships

Tracking Births

1. Record New Births

   • Navigate to a location
   • Click “Record” → “Birth”
   • Enter calf tag, parent tag, birth type, and date
   • The system automatically creates parent records if needed

2. Birth Record Management

   • View all births for a location
   • Edit birth details and relationships
   • Track birth types and dates

Vaccination Management

1. Record Vaccinations

   • Select “Record” → “Vaccination”
   • Choose vaccination date
   • Select vaccination types:
     • Black Leg
     • Respiratory
     • Lepto
     • Wormer

2. Vaccination History

   • View vaccination records by date
   • Track which cattle received specific vaccinations
   • Monitor vaccination schedules

Security Features

• Authentication: Cloudflare Access integration
• Data Validation: Zod schema validation
• Input Sanitization: XSS protection
• HTTPS Only: Secure connections
• CORS Protection: Cross-origin request handling

License

This project is licensed under the MIT License. See the LICENSE file for details.

FAQ