Summary: This is the first beta release of Warracker, an open-source warranty tracker. It includes core features for adding, managing, and tracking warranties, with a focus on providing a functional base for future development.
📝 Warracker v0.01-beta Release Notes
Release Date: March 2, 2025
🎉 Overview
Welcome to the first beta release of Warracker, your open-source solution for tracking product warranties! This release (v0.01-beta) marks the initial public availability of the application and provides the core functionality for managing your warranties. We're excited for you to try it out and provide feedback.
✨ Features Included
This beta release includes the following key features:
- Add Warranty:
- Input product details (name, description).
- Specify purchase date and warranty duration.
- Option to upload supporting documents (receipts, warranty cards, etc.) as files.
- Manage Warranties:
- View a list of all added warranties.
- Edit existing warranty information.
- Delete warranties that are no longer needed.
- Warranty Status:
- Visual indicators for warranty status:
- Active: Warranties currently in effect.
- Expiring Soon: Warranties nearing their expiration date (within a predefined threshold – currently set to 30 days, but not yet configurable).
- Expired: Warranties that have passed their expiration date.
- Visual indicators for warranty status:
- Search:
- Basic search functionality to find warranties by product name.
- Responsive Design:
- The application is designed to be usable on both desktop and mobile devices.
- Dockerized Deployment:
- Easy deployment using Docker and Docker Compose.
🛠️ Technology Stack
This release is built using the following technologies:
- Frontend: HTML, CSS, JavaScript
- Backend: Python (Flask framework)
- Database: PostgreSQL
- Containerization: Docker, Docker Compose
- Web Server: Nginx
🚀 Getting Started
To get started with Warracker v0.01-beta:
- Prerequisites: Ensure you have Docker and Docker Compose installed on your system.
- Clone the Repository:
git clone https://github.com/yourusername/warracker.git cd warracker
- Start the Application:
docker-compose up -d
- Access: Open your web browser and navigate to
http://localhost:8005
.
⚠️ Known Issues and Limitations
As this is a beta release, there are some known issues and limitations:
- No User Authentication: This version does not include user accounts or authentication. All data is stored locally and is accessible to anyone with access to the application instance. Do not store sensitive information in this beta version.
- Limited Error Handling: Error handling is basic. Unexpected errors may result in unhelpful messages.
- No Data Validation: There is minimal input validation. Incorrect data formats may cause unexpected behavior.
- No Email Reminders: The planned email reminder feature is not yet implemented.
- Basic UI: The user interface is functional but may lack polish and advanced features.
- No way to change default port There is currently no way to change the default port of 8005.
- No tests Currently there are no tests for the application.
🤝 Feedback and Contributions
We highly encourage you to provide feedback on this beta release! Your input is crucial for shaping the future development of Warracker. Please report any bugs, suggest features, or share your overall experience via:
- GitHub Issues: The preferred method for reporting bugs and suggesting features is to open an issue on the GitHub repository.
- Pull Requests: Contributions are welcome! Feel free to fork the repository and submit pull requests.
🔮 Future Plans
Upcoming development will focus on:
- User authentication and authorization.
- Email notifications for expiring warranties.
- Improved data validation and error handling.
- Enhanced UI/UX.
- A dedicated settings page.
- Mobile application.
- Adding tests.
🙏 Thank You
Thank you for trying out Warracker! We appreciate your support and look forward to your feedback.