https://github.com/marcusrprojects/springboot-coffeemaker
A full-stack Java web application simulating a coffee maker. Built with Spring Boot, Spring Data JPA, and Thymeleaf + AngularJS, this project allows users to manage recipes and inventory, and simulate making coffee via a RESTful API and web interface.
https://github.com/marcusrprojects/springboot-coffeemaker
angularjs crud-application full-stack inventory-management java maven mysql rest-api spring-boot spring-data-jpa thymeleaf web-application
Last synced: 2 months ago
JSON representation
A full-stack Java web application simulating a coffee maker. Built with Spring Boot, Spring Data JPA, and Thymeleaf + AngularJS, this project allows users to manage recipes and inventory, and simulate making coffee via a RESTful API and web interface.
- Host: GitHub
- URL: https://github.com/marcusrprojects/springboot-coffeemaker
- Owner: marcusrprojects
- Created: 2023-09-02T03:07:43.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-28T04:13:01.000Z (about 1 year ago)
- Last Synced: 2026-01-03T18:51:25.522Z (5 months ago)
- Topics: angularjs, crud-application, full-stack, inventory-management, java, maven, mysql, rest-api, spring-boot, spring-data-jpa, thymeleaf, web-application
- Language: Java
- Homepage:
- Size: 1.83 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Coffee Maker Application
[]()
[]()
[]()
This project was a collaboration between 4 individuals with its work broken into a weekly team portion and a weekly individual portion (separate from the team portion). This repository reflects the weekly individual portion. To see the weekly team portions, please follow this link: [Team Portion of Coffee Maker Project](https://github.com/marcusrprojects/project2-t-03/).
Note that, necessarily, work from both the team portion is present in the individual repository and vice versa in order to make a functioning application.
## Table of Contents
- [Introduction](#introduction)
- [File/Folder Structure](#filefolder-structure)
- [Application Components](#application-components)
- [How to Run](#how-to-run)
- [Testing](#testing)
- [Contributing](#contributing)
- [License](#license)
## Introduction
The Coffee Maker Application is a Java-based software system designed to simulate a coffee maker. It allows users to update inventory, add a recipe, edit recipes, delete recipes, make coffee, add ingredients, and to do so through a web-based interface.
## File/Folder Structure
The project is organized into the following files and folders:
- `.github`: GitHub-specific configuration files.
- `CoffeeMaker`: The main project folder.
- `.mvn/wrapper`: Maven wrapper files for project setup.
- `src/main`: The main source code directory.
- `java/edu/ncsu/csc/CoffeeMaker/controllers`: Controllers for handling web requests.
- `APICoffeeController.java`: Controller for coffee-related API operations.
- `APIController.java`: General API controller.
- `APIIngredientController.java`: Controller for ingredient-related API operations.
- `APIInventoryController.java`: Controller for inventory-related API operations.
- `APIRecipeController.java`: Controller for recipe-related API operations.
- `MappingController.java`: Mapping controller.
- `models`: Model classes representing domain objects.
- `DomainObject.java`: Base class for domain objects.
- `Ingredient.java`: Represents an ingredient.
- `Inventory.java`: Represents the inventory of ingredients.
- `Recipe.java`: Represents a coffee recipe.
- `repositories`: Data repositories for interacting with the database.
- `IngredientRepository.java`: Repository for ingredients.
- `InventoryRepository.java`: Repository for inventory.
- `RecipeRepository.java`: Repository for recipes.
- `services`: Service classes for business logic.
- `IngredientService.java`: Service for ingredient-related operations.
- `InventoryService.java`: Service for inventory-related operations.
- `RecipeService.java`: Service for recipe-related operations.
- `Service.java`: Base service interface.
- `CoffeeMakerApplication.java`: Main Spring Boot application class.
- `resources`: Configuration and static resource files.
- `static/css`: CSS stylesheets.
- `templates`: HTML templates.
- `application.yml.template`: Application configuration template.
- `test/java/edu/ncsu/csc/CoffeeMaker`: Unit and integration tests.
- `api`: API tests.
- `common`: Common test utilities.
- `unit`: Unit tests for various components.
- `.gitignore`: Git ignore file.
- `pom.xml`: Maven project configuration file.
- `images`: Images related to the project (e.g., diagrams).
- `README.md`: This README file.
## Application Components
The Coffee Maker Application consists of several components, including:
- **Controllers**: Handle incoming HTTP requests and manage routing.
- **Models**: Represent the core data structures of the application.
- **Repositories**: Provide data access methods to interact with the database.
- **Services**: Handles CRUD operations performed on models.
- **HTML Templates**: Define the structure of web pages.
- **CSS Stylesheets**: Define the application's styling.
- **Unit and Integration Tests**: Ensure the application functions correctly.
## How to Run
To run the Coffee Maker Application:
1. Clone the repository to your local machine.
2. Open the project in your preferred IDE.
3. Build the project and resolve any dependencies.
4. Run the `CoffeeMakerApplication.java` class to start the application.
5. Access the application in a web browser at `http://localhost:8080`.
## Testing
The project includes unit and integration tests located in the `test` directory. You can run the tests to ensure the correctness of the application's components and functionality.