KitchenCTRL

KitchenCTRL is a Java-based application designed to help users manage their kitchen inventory and recipes efficiently. The application provides a command-line interface for users to add, delete, and list ingredients and recipes, as well as navigate between different sections of the application.

Features

• Inventory Management: Add, delete, and list ingredients in your kitchen inventory.
• Recipe Management: Create, delete, and list recipes.
• Data Persistence: All data is stored locally in text files and is automatically saved after each command.

Useful Links

• User Guide
• Developer Guide
• About Us

Getting Started

Prerequisites

• JDK 17 (use the exact version)
• IntelliJ IDEA (latest version recommended)

Setting Up the Project

1. Ensure IntelliJ JDK 17 is defined as an SDK, as described here.
2. Import the project as a Gradle project, as described here.
3. Verify the setup: After importing, locate the src/main/java/controller/KitchenCTRL.java file, right-click it, and choose Run KitchenCTRL.main(). You should see a welcome message from the application.

Build Automation

This project uses Gradle for build automation and dependency management. Refer to the Gradle Tutorial for more information.

Testing

• I/O Redirection Tests: Navigate to the text-ui-test directory and run the runtest(.bat/.sh) script.
• JUnit Tests: JUnit tests are provided in the src/test/java/kitchenctrl folder. Refer to the JUnit Tutorial for more information.

Checkstyle

A sample CheckStyle rule configuration is provided in this project. Refer to the Checkstyle Tutorial for more information.

Continuous Integration

The project uses GitHub Actions for CI. When you push a commit or create a PR, GitHub Actions will automatically build and verify the code.

Documentation

The /docs folder contains the project documentation. To publish the documentation:

1. Go to your fork on GitHub.
2. Click on the settings tab.
3. Scroll down to the GitHub Pages section.
4. Set the source as master branch /docs folder.
5. Optionally, use the choose a theme button to select a theme for your documentation.