User Guide

Are you an avid chef with an overwhelming collection of delicious recipes? Or perhaps you just want a convenient way to store, access and share your recipes easily?

We understand that for brilliant and creative individuals like yourself, it is essential to properly manage your recipes, which is why RIZZipe is designed and built just for chefs like YOU to organize your recipes at the touch of a finger!

Using this Guide

• If you want to run RIZZipe for the first time, check out our handy Quick Start guide.
• If you want to learn how to use RIZZipe, refer to our Commands section for a detailed guide on how to run each command.
• For experienced developers interested in our design decisions, please refer to our Developer Guide.
• For experienced users, you may refer to the Command summary and Keyboard shortcuts summary for a summarised table of all the commands and keyboard shortcuts available.

Table of Contents

• Using this Guide
• Table of Contents
• Overview
  • What is RIZZipe?
  • Common colour codes in this guide
  • Glossary
• Quick Start
• Commands
  • How to interpret the command format
  • Attributes
    • What is a recipe?
    • Recipe attributes table
    • What is an ingredient?
    • Ingredient attributes table
  • Adding a recipe: add
  • Adding a recipe through form: addf
  • Listing all recipes: list
  • Editing a recipe: edit
  • Finding a recipe by name: find
  • Deleting a recipe: delete
  • Searching for substitutions for an ingredient: sub
  • Asking for assistance: help
  • Clearing the recipe book: clear
  • Exiting the program: exit
• Managing the Data
  • Saving the data
  • Editing the data file
  • Importing data
  • Exporting data
• FAQ
• Command summary
• Keyboard shortcuts summary

Overview

The following subsections detail the functionality of RIZZipe and explain the various terminology and colour coding we will be using in this guide.

What is RIZZipe?

RIZZipe is a command-based recipe database that operates primarily on commands and behaves like a Command Line Interface (CLI).

RIZZipe comes equipped with numerous features, but we particularly love these three:

1. Versatile tagging and powerful search function
2. Recipe sharing
3. Ingredient substitution searching

Give RIZZipe a try and utilise its many features to achieve your culinary rizz today!

Common colour codes in this guide

This is used to display keyboard shortcuts that can help make your journey using RIZZipe more smooth sailing!

This is used to display warnings for you to heed in order for RIZZipe to work as intended!

Glossary

• Command terminal: A terminal is a text input and output environment. It is a program that acts as a wrapper and allows us to enter commands that the computer processes. Open your terminal by:
  • Searching and opening Command Prompt on Windows
  • Searching and opening Terminal on Mac
• cd: Command to change directory
• Command Line Interface (CLI): A text-based user interface (UI) used to run programs, manage computer files and interact with the computer
• JSON: JSON is an open standard file format and data interchange format that uses human-readable text to store and transmit data objects

Quick Start

Let’s get you rizzed up in the fastest way possible!

1. Ensure you have Java 11 or above installed in your computer.
2. Download the latest rizzipe.jar here
3. Copy the file to the folder you want to use as the home folder for RIZZipe.
4. Open a command terminal, cd into the folder you put the jar file in, and input the java -jar rizzipe.jar command to run the application.
5. A GUI similar to the below should appear in a few seconds. Note that our experienced chefs have already crafted some sample recipes for you!
   
   
   
   
6. Navigate through the main window easily using just your keyboard! Toggle between recipes simply by using the ↑ Up and ↓ Down arrow keys!
7. Type commands within the command line interface (CLI) and press Enter to execute it. For a list of executable commands, refer to the Commands Section.
8. Some of the previously mentioned executable commands may have keyboard shortcuts to make your life easier! Refer to each command within the Commands Section, or take a look at the Keyboard Shortcuts summary to learn more about how to use them!

Commands

RIZZipe is a command-driven application, which means its various features and functionalities can be accessed by executing various commands.

How to interpret the command format

Attributes

What is a recipe?

Recipes are the building blocks of RIZZipe! Each recipe consists of multiple attributes, which are listed in the recipe attributes table.

Pay close attention to these attributes, for they are crucial inputs to some of our commands mentioned below!

Recipe attributes table

What is an ingredient?

Ingredients are at the heart of recipes, and also comprise multiple attributes. The specification for recipe ingredients are listed in the table below:

Ingredient attributes table

Adding a recipe: add

Come up with a new innovative recipe and afraid that you’ll forget about it in the future, or just want to share it with your friends? Simply run the add command, and follow the prompts to save different information about your recipe such as ingredients and steps!

Format: add n/RECIPE_NAME [d/RECIPE_DURATION] [p/RECIPE_PORTION] [t/RECIPE_TAGS]... [i/-n INGREDIENT_NAME [-a INGREDIENT_AMOUNT] [-e ESTIMATED AMOUNT] [-cn COMMON NAME] [-r REMARKS]... [-s SUBSTITUTION]...]... [s/RECIPE_STEPS]...

Example(s) of usage:

• add n/Honey Chicken Rice
  
  
  
  
• add n/Chicken Noodles d/20 minutes p/1-2 people i/-n chicken thigh -a 300 g i/-n noodles i/-n soy sauce -a 2 tablespoons -s salt
• add n/Peanut Butter Sandwich t/breakfast s/Prepare bread and spread s/Using a knife, spread 2-3 scoops of peanut butter s/Serve and enjoy.

Adding a recipe through form: addf

Want to add a delicious new recipe but don’t want to type the whole long string of inputs at one go? Use our interactive form feature to add your favorite recipe to the recipe book today!

Format: addf

Listing all recipes: list

Ever forget how many recipes you have in your storage? Want to view ‘em all? Or simply want to pick a recipe at random? Just run the list command!

Format: list

Keyboard Shortcut:
To navigate the list, you can use the ↑ Up and ↓ Down arrow keys (as previously mentioned in the QuickStart). While the recipe you want to zoom in on is selected, simply press P to view that particular recipe’s details!

Editing a recipe: edit

Made a mistake or just omitted some important details when you first stored your recipe in the recipe book? Don’t fret, for the edit command is here for you to supplement these new details to increase the rizz on your recipes!

Format: edit INDEX [n/RECIPE_NAME] [d/RECIPE_DURATION] [p/RECIPE_PORTION] [t/RECIPE_TAGS]... [i/-n INGREDIENT_NAME [-a INGREDIENT_AMOUNT] [-e ESTIMATED AMOUNT] [-cn COMMON NAME] [-r REMARKS]... [-s SUBSTITUTION]...]... [s/RECIPE_STEPS]...

Keyboard shortcut:
As an alternative to typing the full command, we provide a popup form to edit a recipe! While the recipe you want to edit is being selected, simply press F to display the popup form for that particular recipe!

Finding a recipe by name: find

Have a certain recipe at the back of your mind that you want to refer to? Or want to look up all recipes associated with a specific tag or those containing a specific ingredient that you’re desperate to clear but have no idea what to pair it with?

find helps to save your time scrolling through your whole list of recipes by displaying only those that match any of your specified keywords straight away!

Format: find [PROPERTY] KEYWORD [ADDITIONAL KEYWORDS]...
Supported properties: name, tag and ingredient

i.e. find name KEYWORD [ADDITIONAL KEYWORDS]..., find tag KEYWORD [ADDITIONAL KEYWORDS]..., find ingredient KEYWORD [ADDITIONAL KEYWORDS]...

Example(s) of usage:

• find cheese returns all recipes with the keyword cheese in their recipe name
• find name pancakes sandwich returns all recipes with the keyword pancakes and/or sandwich in their names

• find tag western returns all recipes with the tag western
• find ingredient tofu returns all recipes with the ingredient tofu

Deleting a recipe: delete

No longer like a certain recipe? Simply delete it from the database by its index!

Format: delete INDEX

Example(s) of usage:

• list followed by delete 2 deletes the 2nd item stored in the recipe book.
• find chicken, followed by delete 1 will delete the 1st recipe in the displayed results of the find command.

Keyboard shortcut:
While the recipe you want to delete is selected, simply press the Delete or Backspace key and click on confirm to delete that particular recipe!

Searching for substitutions for an ingredient: sub

Short of a particular condiment or ingredient to complete your favourite recipe? Have no fear, for the sub command provides you with a hassle-free way to solve your problem by suggesting some common substitutions so that you can complete your dish with an alternative ingredient!

Format: sub INGREDIENT_NAME

Example(s) of usage:

• sub chicken returns a list of suggested substitutions for the ingredient chicken

Asking for assistance: help

Unsure or unable to remember our list of commands and how to format your inputs? Fret not, as simply inputting help will save you from your woes!

Format: help

Clearing the recipe book: clear

Want to change things up and start a new recipe book afresh? Simply run the clear command to wipe the memory and start afresh!

Format: clear

Caution: Running clear will clear your entire recipe book and there’s no going back!

Exiting the program: exit

Done with cooking for the day? Running exit exits the program and closes the window!

Format: exit

Managing the Data

Saving the data

Recipe data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.

Recipe data is saved as a JSON file in the following directory:

(Location where your Recipe Book JAR File `rizzipe.jar` is)
├── data
│   └── recipebook.json <== Your saved recipe JSON file
├── preferences.json
└── rizzipe.jar

For advanced users, you can change the default location which the recipebook data file is saved to. This can be done by creating a preferences.json file in the base directory where the app is stored, and specifying userPrefsFilePath in preferences.json with the desired file path.

Editing the data file

Advanced users are welcome to update data directly by editing that data file located at the address above.

Caution: If your changes to the data file result in an invalid format, RIZZipe will discard all data and start with an empty data file at the next run.

Importing data

Pressing F3 will open an import window from the main window (as shown in the image below). From there, select the JSON file to be imported using the selector.

Exporting data

The keyboard input F4 will open an export window from the main window (as shown in the image below). From there, input the file name of the JSON file to be exported and select the desired location for it to be saved!

FAQ

Q: How do I transfer my data to another computer?
A: Export the current recipe book with our Export function and send the JSON file to the other computer. On the other computer, run RIZZipe and use the Import function to import all previously saved recipe files!

Command summary

Keyboard shortcuts summary