From 1d05d64fe7d790e1760314a4ee5ffae79652f514 Mon Sep 17 00:00:00 2001 From: sassanix <39465071+sassanix@users.noreply.github.com> Date: Sun, 2 Mar 2025 12:18:56 -0400 Subject: [PATCH] Update README.md The readme is improved by reorganizing sections, clarifying instructions, adding visual elements, and enhancing readability for potential users and contributors. --- README.md | 216 +++++++++++++++++++++--------------------------------- 1 file changed, 85 insertions(+), 131 deletions(-) diff --git a/README.md b/README.md index 04db98c..6a14a3d 100644 --- a/README.md +++ b/README.md @@ -1,138 +1,92 @@ -πŸ›‘οΈ Warracker +# πŸ›‘οΈ 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 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 that provides a centralized system for managing all your product warranties. Key features include: +## 🌟 Overview - Tracking product warranties in one central location. - Adding warranty details, including purchase dates and duration. - Uploading and storing warranty documentation and receipts. - Providing visual indicators for active, expiring soon, and expired warranties. - Searching through your warranty collection. - +Warracker is a web-based application that provides a centralized system for managing all your product warranties. Key features include: -πŸ“Έ Screenshots +* Tracking product warranties in one central location. +* Adding warranty details, including purchase dates and duration. +* Uploading and storing warranty documentation and receipts. +* Providing visual indicators for active, expiring soon, and expired warranties. +* Searching through your warranty collection. -![image](https://github.com/user-attachments/assets/da2a2b2d-4ab9-4e51-bf75-d393b728c39e) +## πŸ“Έ Screenshots -✨ Features +\![image](https://github.com/user-attachments/assets/da2a2b2d-4ab9-4e51-bf75-d393b728c39e) - 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. - +## ✨ Features -πŸ› οΈ Technology Stack +* **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. - Frontend: HTML, CSS, JavaScript - Backend: Python with Flask - Database: PostgreSQL - Containerization: Docker and Docker Compose - Web Server: Nginx - +## πŸ› οΈ Technology Stack -πŸš€ Installation -Prerequisites +* **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). - +## πŸš€ Installation -Setup +### Prerequisites - +* Docker and Docker Compose installed on your system. +* Git (for cloning the repository). - Clone the Repository: - bash - - +### Setup - -1 -2 -git clone https://github.com/yourusername/warracker.git -cd warracker - - - +1. **Clone the Repository:** -Start the Application: -bash - - + ```bash + git clone https://github.com/yourusername/warracker.git + cd warracker + ``` +2. **Start the Application:** - - 1 + ```bash docker-compose up -d - - - + ``` +3. **Access the Application:** - Access the Application: + Open your browser and navigate to `http://localhost:8005`. - Open your browser and navigate to http://localhost:8005. - +## πŸ“ Usage -πŸ“ Usage -Adding a Warranty +### Adding a Warranty - Fill in the product details on the left panel. - Enter the purchase date and warranty duration. - Optionally upload receipt/documentation. - Click the "Add Warranty" button. - +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 +### 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. - +* 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 +## πŸ’» Development - +### Local Development Environment - Clone the repository. - +1. Clone the repository. +2. Make your changes. +3. Build and run with Docker Compose: - Make your changes. - - - Build and run with Docker Compose: - bash - - - - - 1 - 2 + ```bash docker-compose build docker-compose up -d - - - + ``` -Project Structure - - - -1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 +### Project Structure + +``` warracker/ β”œβ”€β”€ backend/ # Python Flask backend β”‚ β”œβ”€β”€ app.py # Main application logic @@ -145,40 +99,40 @@ warracker/ β”œβ”€β”€ docker-compose.yml # Docker configuration β”œβ”€β”€ Dockerfile # Container definition └── nginx.conf # Web server configuration - - -πŸ—ΊοΈ Roadmap +``` - User authentication. - Email reminders for expiring warranties. - Mobile app. - Settings page. - Status page. - +## πŸ—ΊοΈ Roadmap -πŸ› οΈ Troubleshooting -Common Issues +* User authentication. +* Email reminders for expiring warranties. +* Mobile app. +* Settings page. +* Status page. - 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. - +## πŸ› οΈ Troubleshooting -🀝 Contributing +### Common Issues -Contributions are welcome! We encourage you to submit a Pull Request. +* **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`. - Fork the repository. - Create your feature branch (git checkout -b feature/amazing-feature). - Commit your changes (git commit -m 'Add some amazing feature'). - Push to the branch (git push origin feature/amazing-feature). - Open a Pull Request. - +## 🀝 Contributing -πŸ“œ License +Contributions are welcome! We encourage you to submit a Pull Request. -This project is licensed under the MIT License - see the LICENSE file for details. (Make sure you have a LICENSE file in your root directory). -πŸ™ Acknowledgements +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. - Flask - PostgreSQL +## πŸ“œ License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. (Make sure you have a LICENSE file in your root directory). + +## πŸ™ Acknowledgements + +* Flask +* PostgreSQL +* Docker Docker