Project Title

DigitalCookBook — Desktop Recipe Manager (Java Swing)

Description

DigitalCookBook is a small, modular Java desktop application that helps cooks, chefs and viewers manage recipes locally. It provides a Swing-based user interface for signing up and signing in users, adding and editing recipes, categorizing recipes, and marking favourites. The app uses JDBC for persistence and is organized with a clear package layout for dao, model, services, and ui layers.

This repository contains the full source code under src/ and is structured so it can be built and run with a standard Java toolchain (JDK 11+ recommended).

👤 User Management

• Three types of users: Admin, Chef, and Viewer
• Sign Up as a Chef or Viewer
• Login / Logout functionality with role-based access
• Secure credential storage and validation

---

🧑‍🍳 Chef Features

• Add new recipes with:
  • Title
  • Ingredients
  • Category (Veg, Non-Veg, Dessert)
  • Image upload
  • Step-by-step instructions
• Edit or Delete owned recipes
• View Admin Announcements in a dedicated announcement panel

---

👁️ Viewer Features

• Browse all recipes
• Search recipes by title or filter by category (via dropdown)
• Mark recipes as Favourite / Unfavourite
• View all favourite recipes in a separate Favourites Section
• Browse Chef List and view all recipes by a particular chef
• Access Announcements made by the admin

---

🧑‍💼 Admin Features

• Manage users:
  • View and Delete Chefs and their recipes
  • View and Delete Viewers
• Announcement System:
  • Create announcements for:
    • Chefs
    • Viewers
    • Both
  • Manage and remove announcements
• Centralized dashboard to monitor all users and recipes

---

💾 Technical Overview

• Language: Java (JDK 11+)
• UI: Swing
• Database: JDBC-based persistence
• Architecture: Layered (dao, model, service, ui)
• Entry Point: Main.java (launches the Swing UI)

📁 Project Structure

digitalCookBook/
│
├── src/
│ ├── dao/
│ │ ├── dbConnection/
│ │ │ └── DBConnection.java
│ │ ├── RecipeDao.java
│ │ ├── UserDao.java
│ │ └── ...
│ │
│ ├── model/
│ │ ├── User.java
│ │ ├── Recipe.java
│ │ ├── Announcement.java
│ │ └── ...
│ │
│ ├── service/
│ │ ├── AuthService.java
│ │ ├── RecipeService.java
│ │ ├── AnnouncementService.java
│ │ └── ...
│ │
│ ├── ui/
│ │ ├── auth/
│ │ │ ├── LoginPage.java
│ │ │ ├── SignUpPage.java
│ │ │ └── ...
│ │ │
│ │ ├── admin/
│ │ │ ├── AdminDashboard.java
│ │ │ ├── AnnouncementPanel.java
│ │ │ └── ...
│ │ │
│ │ ├── chef/
│ │ │ ├── ChefDashboard.java
│ │ │ ├── AddRecipeForm.java
│ │ │ └── ...
│ │ │
│ │ ├── viewer/
│ │ │ ├── ViewerDashboard.java
│ │ │ ├── FavouritePanel.java
│ │ │ └── ...
│ │ │
│ │ └── Main.java
│ │
│ ├── util/
│ │ ├── LogoutAction.java
│ │ └── StyleActionBtn.java
│ │
│ └── resources/
│ ├── icons/
│ └── images/
│
├── README.md
└── .gitignore

Installation

Prerequisites:

• Java JDK 11 or later installed and available on your PATH. The project uses the Java module system and Swing.

Steps:

1. Clone or download this repository.
2. From the project root open a terminal/command prompt.
3. Compile the sources. From the src folder you can compile with javac or from the project root; examples below assume you are at the repository root and have a JDK installed.

Compile (from project root):

javac -d out --module-source-path src $(find src -name "*.java")

This places compiled classes under out/ using the module source path. On Windows with Git Bash you may need to adjust the find command or provide a list of files.

Usage

Run the application using the Java module system. The project's module name is digitalCookBook (see src/module-info.java). The following runs the main class located in main.Main:

java --module-path out -m digitalCookBook/main.Main

If you prefer a simpler classpath run (for development), compile without modules and run the Main class directly. Example:

# compile (non-modular)
javac -d classes $(find src -name "*.java")
# run
java -cp classes main.Main

Notes:

• The app expects a local JDBC connection handled by dao/dbConnection/DBConnection.java. Configure any connection strings or embedded database files there if needed.
• If you plan to package the app as a runnable JAR, create a manifest with the Main-Class: main.Main entry and include all compiled classes and resource files.

Contributing

Contributions are welcome. Suggested workflow:

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/your-feature).
3. Make small, focused commits.
4. Run and manually test the app locally.
5. Open a pull request describing the change.

When contributing, please:

• Follow the existing package structure and naming conventions.
• Add unit tests where appropriate (this project is Swing-heavy and may require integration tests).
• Keep UI changes incremental and documented.

License

This project is provided under the MIT License. You can copy, modify and distribute the code. Replace this block with a different license if you prefer.