🛡️ Warracker

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

🌟 Overview

Warracker is a web-based application that provides a centralized system for managing all your product warranties. Key features include:

• Centralized Warranty Management: Track all product warranties in one place.
• Detailed Records: Store key warranty information like purchase date and duration.
• Document Storage: Upload and securely store warranty documentation and receipts.
• Proactive Alerts: Visual indicators for active, soon-to-expire (add the number of days between 1-365 in settings), and expired warranties.
• Quick Search: Easily find specific warranties within your collection.
• Secure Access: User authentication and support for multiple users.
• System Status: Real-time system status page.
• Data Export: Export warranty data to CSV format.

📸 Screenshots

Home Page

Status Dashboard

✨ Features

• Warranty Management: Add, edit, and delete warranty information.
• Document Storage: Upload and securely store receipts and warranty documentation.
• Status Tracking: Visual indicators for warranty status (active, expiring soon, expired).
• Search: Easily find warranties by product name.
• Responsive Design: A seamless experience on both desktop and mobile devices.

🛠️ Technology Stack

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

🚀 Setup

Prerequisites

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

Fresh Installation 🆕

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
   

Updating from a Previous Version ⬆️

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.

📝 Usage

Adding a Warranty

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

Managing Warranties

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

💻 Development

Local Development Environment

1. Clone the repository.

2. Make your changes.

3. Build and run with Docker Compose:

   docker-compose build
   docker-compose up -d
   

Project Structure

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

🗺️ Roadmap

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

🛠️ Troubleshooting

Common Issues

• 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.

🤝 Contributing

Contributions are welcome! We encourage you to submit a Pull Request.

1. Fork the repository.
2. Create your feature branch (git checkout -b feature/amazing-feature).
3. Commit your changes (git commit -m 'Add some amazing feature').
4. Push to the branch (git push origin feature/amazing-feature).
5. Open a Pull Request.

📜 License

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

🙏 Acknowledgements

• Flask
• PostgreSQL
• Docker

⭐ Star History