# π‘οΈ 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:** Get visual notifications for active, expiring (customizable from 1 to 365 days), 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.
* **Email notifications:** Stay informed about expiring warranties with email reminders, based on your preference delivered daily, weekly, or monthly.
* **Tagging:** Add tags to help categorize and group warranties.
## πΈ 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 or tags.
* **Tag**: Group your warranties by using multiple tags.
* **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`.
## π Pull Docker
```
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
- SMTP_USERNAME=youremail@email.com
- SMTP_PASSWORD=password
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](https://github.com/sassanix/Warracker/tree/main/Docker)
## π 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:
```bash
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 β **
* Customizing Reminders to any day needed - **Completed β **
* Email Reminders for Expiring Warranties - **Completed β **
* Warranty Categories/Grouping through tags - **Completed β **
* Warranty Data Import (CSV) - **Planned**
* Improved Search and Filtering - **Planned**
* Warranty claim tracking - **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](LICENSE) file for details.
## π Acknowledgements
* Flask
* PostgreSQL
* Docker
## β Star History