PlantBuddy is a user-friendly desktop application built with JavaFX that simplifies plant care by helping you track, schedule, and manage your beloved green companions. Forget missed waterings or forgotten fertilizers – PlantBuddy keeps you on top of your plant care routine with intuitive visuals and timely reminders!
- Effortless Plant Management: Easily add new plants with their unique details and even upload a photo to personalize your dashboard.
- Custom Care Schedules: Set precise watering and fertilizing days for each plant, tailoring the care to their specific needs.
- Visual Progress Tracking: A dynamic progress bar clearly shows you the time remaining until your next watering day, making it easy to see what's due at a glance.
- One-Click Task Completion: After you've watered or fertilized, simply click the "Watered" or "Fertilized" button to reset the progress bar and update the schedule.
- Intuitive User Interface: A clean and responsive design powered by JavaFX and CSS ensures a smooth and enjoyable user experience.
- Frontend:
- For building a rich and interactive desktop user interface.
- For styling the application, ensuring a modern and appealing look.
- Backend & Database:
- Used for connecting the Java application to the database.
- A robust relational database to store all your plant details, schedules, and care history.
Follow these steps to get PlantBuddy up and running on your local machine.
Before you begin, ensure you have the following installed:
- Java Development Kit (JDK) 11 or higher
- MySQL Database Server
- Maven (Highly Recommended for easy dependency management)
-
Clone the Repository:
git clone [https://github.com/your-username/PlantBuddy.git](https://github.com/your-username/PlantBuddy.git) cd PlantBuddy(Remember to replace
your-usernamewith the actual GitHub username where your project is hosted.) -
Database Configuration:
- Create a new MySQL database for PlantBuddy (e.g.,
plantbuddy_db). - Import the database schema by running the SQL script located at
src/main/resources/database/schema.sql(or similar path in your project structure) into your new MySQL database. - Update the database connection properties in
src/main/resources/application.properties(or your equivalent configuration file) with your MySQL credentials (username, password, database name).
- Create a new MySQL database for PlantBuddy (e.g.,
-
Build and Run:
- Using Maven (Recommended):
mvn clean install mvn javafx:run
- Without Maven: You'll need to manually compile your JavaFX application and include all necessary dependencies (JavaFX modules, MySQL JDBC driver). This method is more complex and depends on your specific IDE setup.
- Using Maven (Recommended):
- Launch PlantBuddy: Run the application after following the installation steps.
- Add Your Plants: Click on the "Add Plant" button. Fill in details like the plant's name, species, and upload a beautiful photo! Set your preferred watering and fertilizing days.
- Monitor Your Dashboard: Your plants will appear on the main dashboard, each with a visual progress bar indicating the next watering date.
- Update Care Status: Once you've watered or fertilized a plant, simply click the corresponding "Watered" or "Fertilized" button next to its entry. The progress bar will reset, and the next care day will be calculated!
We welcome contributions to make PlantBuddy even better! If you'd like to contribute, please follow these steps:
- Fork the repository.
- Create a new branch for your feature (
git checkout -b feature/your-feature-name). - Make your changes and ensure tests (if any) pass.
- Commit your changes (
git commit -m 'feat: Add new awesome feature'). - Push to the branch (
git push origin feature/your-feature-name). - Open a Pull Request with a clear description of your changes.
This project is open-source and available under the MIT License.
Have questions, suggestions, or just want to connect? Feel free to reach out to me!
- Email: bhargava.anandakumar@gmail.com
- LinkedIn: Bhargava A