Warracker

Warracker is an open-source warranty tracker application designed to help you effortlessly keep track of product warranties, expiration dates, and related documentation.

Warracker is a web-based application designed to simplify and centralize product warranty management. Key capabilities include:

• Centralized Warranty Management: Track and manage all your product warranties in one place.
• Detailed Records: Save essential details like purchase dates, durations, and notes.
• Document Storage: Upload and securely store receipts, invoices, product manuals, and other related files (e.g., ZIP, RAR archives).
• Proactive Alerts: Visual notifications for active, expiring (customizable from 1 to 365 days), and expired warranties.
• Quick Search and Filter: Instantly find warranties by product name, serial numbers, vendor, tags, or notes.
• Notes Support: Add freeform notes to each warranty for extra context or reminders.
• Secure Access with Multi-User Support: Create multiple user accounts for shared access; admins can enable or disable new user creation.
• System Status Dashboard: Real-time system health and warranty summary.
• Data Export and Import: Export warranty data to CSV, or import warranties from CSV files.
• Email Notifications: Receive timely email reminders about upcoming expirations — configurable as daily, weekly, or monthly.
• Customizable Currency Symbols: Display prices using your preferred currency symbol ($, €, £, ¥, ₹, or a custom symbol).
• Customizable Dates: Display dates based on your own region.
• Tagging: Organize warranties with flexible, multi-tag support.
• Password Reset: Easily recover accounts through a secure, token-based password reset flow.

Home Page

Status Dashboard

• Warranty Management: Add, edit, and delete warranty information easily.
• Document Storage: Upload and manage receipts, invoices, and product manuals securely.
• Extended Document Storage: Securely upload and store additional product-related documents or files in ZIP or RAR format.
• Status Tracking: Visual indicators for warranty status (active, expiring soon, expired).
• Notes: Add detailed notes for each warranty, viewable and editable via a dedicated notes modal.
• Search and Tagging: Find warranties quickly using product names, serial numbers, vendor, notes, or multiple tags.
• Multi-User Management: Support for multiple user accounts; admin users can control whether new accounts can be created.
• Responsive Design: Optimized for both desktop and mobile devices.
• Secure Login: Safe and private authentication for all users.
• Password Reset: Token-based secure password recovery flow.
• Email Alerts: Customize how and when you receive expiration notifications.
• CSV Export/Import: Full support for backing up and restoring warranty data.
• Currency Customization: Personalize displayed prices with your preferred symbol.

• Frontend: HTML, CSS, JavaScript
• Backend: Python with Flask
• Database: PostgreSQL
• Containerization: Docker and Docker Compose
• Web Server: Nginx

• Docker and Docker Compose installed on your system.
• Git (for cloning the repository).

1. Clone the repository:

   git clone https://github.com/sassanix/Warracker.git
   

2. Navigate to the project directory:

   cd Warracker
   

3. Start the application using Docker:

   docker compose up
   

1. Pull the latest changes:

   git pull origin main
   

2. Rebuild and restart the containers:

   docker compose down
   docker compose up --build
   

3. Access the Application:

   Open your browser and navigate to http://localhost:8005.

services:
  warracker:
    image: ghcr.io/sassanix/warracker/main:latest
    ports:
      - "8005:80"
    volumes:
      - warracker_uploads:/data/uploads
    environment:
      - DB_HOST=warrackerdb
      - DB_NAME=warranty_db
      - DB_USER=warranty_user
      - DB_PASSWORD=${DB_PASSWORD:-warranty_password}
      - SMTP_HOST=smtp.email.com
      - SMTP_PORT=465
      - [email protected]
      - SMTP_PASSWORD=password
      - SECRET_KEY=${APP_SECRET_KEY:-your_strong_default_secret_key_here} 
      - MAX_UPLOAD_MB=32 # Example: Set max upload size to 32MB 
      - NGINX_MAX_BODY_SIZE_VALUE=32M # For Nginx, ensure this matches MAX_UPLOAD_MB in concept (e.g., 32M)
    # - FLASK_DEBUG=0
    depends_on:
      warrackerdb:
        condition: service_healthy
    restart: unless-stopped
  
  warrackerdb:
    image: postgres:15-alpine
    volumes:
      - postgres_data:/var/lib/postgresql/data
    environment:
      - POSTGRES_DB=warranty_db
      - POSTGRES_USER=warranty_user
      - POSTGRES_PASSWORD=${DB_PASSWORD:-warranty_password}
    restart: unless-stopped

    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U $$POSTGRES_USER -d $$POSTGRES_DB"]
      interval: 5s
      timeout: 5s
      retries: 5

volumes:
  postgres_data:
  warracker_uploads:

To get the docker compose file please go here

1. Fill in the product details by clicking on add warranty.
2. Enter the purchase date and warranty duration.
3. Optionally upload receipt/documentation.
4. Click the "Add Warranty" button.

• Use the search box to filter warranties.
• Click the edit icon to modify warranty details.
• Click the delete icon to remove a warranty.

1. Clone the repository.

2. Make your changes.

3. Build and run with Docker Compose:

   docker-compose build
   docker-compose up -d

warracker/
├── backend/             # Python Flask backend
│   ├── app.py           # Main application logic
│   ├── requirements.txt # Python dependencies
│   └── init.sql         # Database initialization
├── frontend/            # Web frontend
│   ├── index.html
│   ├── script.js
│   └── style.css
├── docker-compose.yml   # Docker configuration
├── Dockerfile           # Container definition
└── nginx.conf           # Web server configuration

• User Authentication - Completed ✅
• Settings Page - Completed ✅
• Status Page - Completed ✅
• Customizing Reminders to any day needed - Completed ✅
• Email Reminders for Expiring Warranties - Completed ✅
• Warranty Categories/Grouping through tags - Completed ✅
• Warranty Data Import (CSV) - Completed ✅
• Improved Search and Filtering - Completed ✅
• Warranty claim tracking - Planned
• Calendar Integration - Planned

• Connection Refused Error: Ensure all containers are running (docker-compose ps). Verify the backend is correctly connected to the database.
• Database Errors: If schema issues arise, double-check that the database initialization script (init.sql) matches the expected schema in app.py.

We welcome contributions and appreciate your interest in improving this project! To get started, please follow these steps:

1. Fork the repository.
2. Create a branch for your changes: git checkout -b feature/amazing-feature
3. Commit your changes: git commit -m "Add: amazing feature"
4. Push to your forked repository: git push origin feature/amazing-feature
5. Open a Pull Request with a clear explanation of your changes.

• Start with an issue: Before submitting a Pull Request, ensure the change has been discussed in an issue.
• Help is welcome: Check the issues for open discussions or areas where help is needed.
• Keep it focused: Each Pull Request should focus on a single change or feature.
• Follow project style: Match the project's code style and naming conventions.
• Be respectful: We value inclusive and constructive collaboration.

This project is licensed under the GNU Affero General Public License v3.0 - see the LICENSE file for details.

• Flask
• PostgreSQL
• Docker