{"id":26132253,"url":"https://github.com/sassanix/warracker","last_synced_at":"2025-04-10T00:16:35.481Z","repository":{"id":280223940,"uuid":"941324731","full_name":"sassanix/Warracker","owner":"sassanix","description":"An open-source web application to manage product warranties, track expiration dates, and store related documents. ","archived":false,"fork":false,"pushed_at":"2025-04-06T17:23:30.000Z","size":906,"stargazers_count":199,"open_issues_count":5,"forks_count":8,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-10T00:02:50.725Z","etag":null,"topics":["beta","css","database","docker","flask","html","javascript","nginx","open-source","postgresql","python","self-hosted","warranty-management","warranty-tracker","web-application"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sassanix.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-03-02T02:40:52.000Z","updated_at":"2025-04-09T10:31:21.000Z","dependencies_parsed_at":null,"dependency_job_id":"cbee65dc-47ea-492f-b434-9cfea963a43d","html_url":"https://github.com/sassanix/Warracker","commit_stats":null,"previous_names":["sassanix/warracker"],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sassanix%2FWarracker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sassanix%2FWarracker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sassanix%2FWarracker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sassanix%2FWarracker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sassanix","download_url":"https://codeload.github.com/sassanix/Warracker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248131315,"owners_count":21052819,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["beta","css","database","docker","flask","html","javascript","nginx","open-source","postgresql","python","self-hosted","warranty-management","warranty-tracker","web-application"],"created_at":"2025-03-10T23:00:54.972Z","updated_at":"2025-04-10T00:16:35.468Z","avatar_url":"https://github.com/sassanix.png","language":"JavaScript","readme":"\n\u003cdiv align=\"center\"\u003e\n    \n![420682616-b65106d3-2c3c-4f6c-a4b7-4ec6e010e5b8](https://github.com/user-attachments/assets/cb373fe8-b4d2-47ac-bf7b-060289e6e17c)\n\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n    \n\u003c!-- ![GitHub forks](https://img.shields.io/github/forks/sassanix/Warracker?style=social) --\u003e\n![GitHub issues](https://img.shields.io/github/issues/sassanix/Warracker)\n![GitHub license](https://img.shields.io/github/license/sassanix/Warracker)\n![GitHub last commit](https://img.shields.io/github/last-commit/sassanix/Warracker)\n![GitHub release](https://img.shields.io/github/v/release/sassanix/Warracker)\n![GitHub contributors](https://img.shields.io/github/contributors/sassanix/Warracker)\n\u003c!-- ![Downloads](https://img.shields.io/github/downloads/sassanix/Warracker/total) --\u003e\n[![Dependencies Status](https://img.shields.io/badge/dependencies-up%20to%20date-brightgreen.svg)](https://github.com/denser-org/denser-retriever/pulls?utf8=%E2%9C%93\u0026q=is%3Apr%20author%3Aapp%2Fdependabot)\n![Maintenance](https://img.shields.io/badge/Maintained-Actively-green)\n\n#\n    \n\u003c/div\u003e\n\n# 🛡️ Warracker\n\nWarracker is an open-source warranty tracker application designed to help you effortlessly keep track of product warranties, expiration dates, and related documentation.\n\n## 🌟 Overview\n\nWarracker is a web-based application that provides a centralized system for managing all your product warranties. Key features include:\n\n* **Centralized Warranty Management:** Track all product warranties in one place.\n* **Detailed Records:** Store key warranty information like purchase date and duration.\n* **Document Storage:** Upload and securely store warranty documentation and receipts.\n* **Proactive Alerts:** Get visual notifications for active, expiring (customizable from 1 to 365 days), and expired warranties.\n* **Quick Search:** Easily find specific warranties within your collection.\n* **Secure Access:**  User authentication and support for multiple users.\n* **System Status:** Real-time system status page.\n* **Data Export:** Export warranty data to CSV format.\n* **Email notifications:** Stay informed about expiring warranties with email reminders, based on your preference delivered daily, weekly, or monthly.\n* **Tagging:** Add tags to help categorize and group warranties.\n\n\n## 📸 Screenshots\n\n**Home Page**\n\n![image](https://github.com/user-attachments/assets/a89d1c86-a70c-488f-920a-d0c5ff2a5009)\n\n![image](https://github.com/user-attachments/assets/af34a7e4-5475-486c-acaa-2cbc65a14600)\n\n**Status Dashboard**  \n\n![image](https://github.com/user-attachments/assets/42bcf2b1-46fa-4136-abfa-bed747fa08e9)\n\n\n## ✨ Features\n\n*   **Warranty Management**: Add, edit, and delete warranty information.\n*   **Document Storage**: Upload and securely store receipts and warranty documentation.\n*   **Status Tracking**: Visual indicators for warranty status (active, expiring soon, expired).\n*   **Search**: Easily find warranties by product name or tags.\n*   **Tag**: Group your warranties by using multiple tags.\n*   **Responsive Design**: A seamless experience on both desktop and mobile devices.\n\n## 🛠️ Technology Stack\n\n*   **Frontend**: HTML, CSS, JavaScript\n*   **Backend**: Python with Flask\n*   **Database**: PostgreSQL\n*   **Containerization**: Docker and Docker Compose\n*   **Web Server**: Nginx\n\n## 🚀 Setup\n\n### Prerequisites\n\n*   Docker and Docker Compose installed on your system.\n*   Git (for cloning the repository).\n\n### Fresh Installation 🆕\n1. Clone the repository:\n   ```\n   git clone https://github.com/sassanix/Warracker.git\n   ```\n2. Navigate to the project directory:\n   ```\n   cd Warracker\n   ```\n3. Start the application using Docker:\n   ```\n   docker compose up\n   ```\n\n### Updating from a Previous Version ⬆️\n1. Pull the latest changes:\n   ```\n   git pull origin main\n   ```\n2. Rebuild and restart the containers:\n   ```\n   docker compose down\n   docker compose up --build\n   ```\n3.  **Access the Application:**\n\n    Open your browser and navigate to `http://localhost:8005`.\n\n\n## 🐋 Pull Docker\n\n\n```\n  services:\n  warracker:\n    image: ghcr.io/sassanix/warracker/main:latest\n    ports:\n      - \"8005:80\"\n    volumes:\n      - warracker_uploads:/data/uploads\n    environment:\n      - DB_HOST=warrackerdb\n      - DB_NAME=warranty_db\n      - DB_USER=warranty_user\n      - DB_PASSWORD=${DB_PASSWORD:-warranty_password}\n      - SMTP_HOST=smtp.email.com\n      - SMTP_PORT=465\n      - SMTP_USERNAME=youremail@email.com\n      - SMTP_PASSWORD=password\n    depends_on:\n      warrackerdb:\n        condition: service_healthy\n    restart: unless-stopped\n  \n  warrackerdb:\n    image: postgres:15-alpine\n    volumes:\n      - postgres_data:/var/lib/postgresql/data\n    environment:\n      - POSTGRES_DB=warranty_db\n      - POSTGRES_USER=warranty_user\n      - POSTGRES_PASSWORD=${DB_PASSWORD:-warranty_password}\n    restart: unless-stopped\n\n    healthcheck:\n      test: [\"CMD-SHELL\", \"pg_isready -U $$POSTGRES_USER -d $$POSTGRES_DB\"]\n      interval: 5s\n      timeout: 5s\n      retries: 5\n\nvolumes:\n  postgres_data:\n  warracker_uploads:\n```\n\nTo get the docker compose file please go [here](https://github.com/sassanix/Warracker/tree/main/Docker)\n\n## 📝 Usage\n\n### Adding a Warranty\n\n1.  Fill in the product details on the left panel.\n2.  Enter the purchase date and warranty duration.\n3.  Optionally upload receipt/documentation.\n4.  Click the \"Add Warranty\" button.\n\n### Managing Warranties\n\n*   Use the search box to filter warranties.\n*   Click the edit icon to modify warranty details.\n*   Click the delete icon to remove a warranty.\n\n## 💻 Development\n\n### Local Development Environment\n\n1.  Clone the repository.\n2.  Make your changes.\n3.  Build and run with Docker Compose:\n\n    ```bash\n    docker-compose build\n    docker-compose up -d\n    ```\n\n### Project Structure\n\n```\nwarracker/\n├── backend/             # Python Flask backend\n│   ├── app.py           # Main application logic\n│   ├── requirements.txt # Python dependencies\n│   └── init.sql         # Database initialization\n├── frontend/            # Web frontend\n│   ├── index.html\n│   ├── script.js\n│   └── style.css\n├── docker-compose.yml   # Docker configuration\n├── Dockerfile           # Container definition\n└── nginx.conf           # Web server configuration\n```\n\n## 🗺️ Roadmap\n\n*   User Authentication - **Completed ✅**\n*   Settings Page - **Completed ✅**\n*   Status Page - **Completed ✅**\n*   Customizing Reminders to any day needed - **Completed ✅**\n*   Email Reminders for Expiring Warranties - **Completed ✅**\n*   Warranty Categories/Grouping through tags - **Completed ✅**\n*   Warranty Data Import (CSV) - **Planned**\n*   Improved Search and Filtering - **Planned**\n*   Warranty claim tracking - **Planned**\n*   Calendar Integration - **Planned**\n\n\n## 🛠️ Troubleshooting\n\n### Common Issues\n\n*   **Connection Refused Error**:  Ensure all containers are running (`docker-compose ps`). Verify the backend is correctly connected to the database.\n*   **Database Errors**: If schema issues arise, double-check that the database initialization script (`init.sql`) matches the expected schema in `app.py`.\n\n## 🤝 Contributing\n\nContributions are welcome! We encourage you to submit a Pull Request.\n\n1.  Fork the repository.\n2.  Create your feature branch (`git checkout -b feature/amazing-feature`).\n3.  Commit your changes (`git commit -m 'Add some amazing feature'`).\n4.  Push to the branch (`git push origin feature/amazing-feature`).\n5.  Open a Pull Request.\n\n## 📜 License\n\nThis project is licensed under the GNU Affero General Public License v3.0 - see the [LICENSE](LICENSE) file for details.\n\n## 🙏 Acknowledgements\n\n*   Flask\n*   PostgreSQL\n*   Docker\n\n## ⭐ Star History\n\u003ca href=\"https://star-history.com/#sassanix/Warracker\u0026Date\"\u003e\n \u003cpicture\u003e\n   \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://api.star-history.com/svg?repos=sassanix/Warracker\u0026type=Date\u0026theme=dark\" /\u003e\n   \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://api.star-history.com/svg?repos=sassanix/Warracker\u0026type=Date\" /\u003e\n   \u003cimg alt=\"Star History Chart\" src=\"https://api.star-history.com/svg?repos=sassanix/Warracker\u0026type=Date\" /\u003e\n \u003c/picture\u003e\n\u003c/a\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsassanix%2Fwarracker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsassanix%2Fwarracker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsassanix%2Fwarracker/lists"}