PowerBake User Guide

Introduction

PowerBake is a desktop application designed to help small home bakery businesses track clients, manage pastry inventory, and organize orders efficiently.

Using PowerBake, you can efficiently manage your bakery with:

• Quick Overview: Instantly access client details, pastry details, and order statuses at a glance.
• Order Tracking: Keep track of each order's progress, from placement to delivery or pickup.
• Ease of use: Intuitive and simple commands that anyone can pick up.

To enhance speed and productivity, PowerBake is optimized for a Command Line Interface (CLI) while still providing the benefits of a Graphical User Interface (GUI).

^ Back to top

---

Prerequisite Knowledge

This guide is designed to be accessible to all users, whether you’re a new or experienced user.

If you are a new PowerBake user:

• Do refer to the Glossary section to understand the key terminologies used in the guide.
• Check out our Getting Started section to get started with using PowerBake!

If you are an experienced PowerBake user:

• The Command Summary section provides a quick overview of all available commands in PowerBake.
• The Features section can give more specific insight as to the features of PowerBake and each command.

Our goal is to make managing your bakery as smooth and efficient as possible, regardless of your level of experience.

For additional information, you may refer to the FAQ section or the Known Issues section.

^ Back to top

---

Understanding the User Guide

This section outlines the various elements found in this guide and explains what they represent.

Additional Info

Additional information are shown as a box with a "i" symbol.

Warnings

Warnings are shown typically as a box with an exclamation mark as a symbol.

Tips

Similarly, tips are shown within a box with a lightbulb as its symbol.

^ Back to top

---

Getting Started

Let's learn how to get started with PowerBake! This guide will walk you through on how to install the application and how to use it!

^ Back to top

---

Installation

1. Ensure you have Java 17 or above installed.

2. Download the latest powerbake.jar file from our Github's latest release.

3. Find the file you have just downloaded. It is called powerbake.jar.

4. Create a new folder to use as the home folder for PowerBake.

   • It is recommended to use a new & empty folder to prevent any data loss.
   • This folder can be created anywhere on your computer.

5. Copy the file to the newly created folder.

   How to copy the file into the new folder:

   1. Right click on powerbake.jar and select Copy.

   2. Navigate to the newly created folder.

   3. Right click on the folder and select Paste.

6. At the end you should have an empty folder with the powerbake.jar file in it similar to this:

   

^ Back to top

---

Starting PowerBake

Now that you have installed PowerBake, lets learn how to launch it!

1. Open a command terminal

   • Windows: open the start menu and search for cmd then press Enter
   • MacOS: open spotlight search and search for Terminal then press Enter
   • Linux press Ctrl + Alt + T to open the command terminal.
   
   
   How to use the terminal:

   If you are unsure about how to use the terminal you can follow this guide.

2. Navigate into the folder you created earlier.

   How to navigate into the folder:

   1. Open the command terminal.

   2. Type cd (with a space after cd).

   3. Drag the folder into the terminal window.

   4. Press Enter.

3. Run the following command to start PowerBake:

   java -jar powerbake.jar
   

4. After a brief moment, you should see a window similar to this:

   
   The first time you run PowerBake, it will contain sample data.
   This helps you understand how the entries will appear and how the app will feel like when you start using it.

   Index	Component Name	Description
   1	Command Box	You can type commands here and press Enter to execute them.
   2	Result Display Box	Displays the result of executing a command.
   3	Current View	Displays which tab you are currently viewing
   4	List View	Displays the information of the tab you have currently open

Now that you have PowerBake running, lets learn how to use it to manage your customers and orders in this tutorial!

^ Back to top

---

Tutorial

Managing your Bakery with PowerBake!

This tutorial will guide you through the process of managing your bakery with PowerBake. When you're done you'll be familiar with the typical workflow of PowerBake!

Step 1: Adding a Client

Purpose: Before we can start managing our bakery, we need to have a list of our clients.

Imagine you have a a new client, Luke, who has just placed an order with you. Lets add him to PowerBake!

To add him to PowerBake, use this command in the Command Box

add client Luke -p 88776655 -a 5 Punggol Street -e luke@gmail.com

This command specifies the following details about Luke:

• Name: Luke
• Phone Number: 88776655 using the -p flag
• Address: 5 Punggol Street using the -a flag
• Email: luke@gmail.com using the -e flag

After hitting Enter, you should see a message indicating that Luke has been successfully added to PowerBake and the new entry should appear in the List View.

1. The Result Display Box will show a message indicating that Luke has been successfully added.
2. The List View will display the details of Luke.

Congrats! You have successfully added your first client to PowerBake!

Step 2: Adding a Pastry

Purpose: Now that we have a client, we need to add the pastries that we offer to our clients.

So far we have created new a new client, Luke. Now, lets add a new pastry, Croissant, to PowerBake!

To add the Croissant to PowerBake, use this command in the Command Box and hit Enter:

add pastry Croissant -pr 5.5

This command specifies the following details about the Croissant:

• Pastry Name: Croissant
• Price: $5.50 using the -pr flag

Hitting Enter will display a message indicating that the Croissant has been successfully added to PowerBake and the new entry should appear in the List View.

1. The Result Display Box will show a message indicating that the Croissant has been successfully added.
2. The List View will display the details of the Croissant.

Nice! You have successfully added your first pastry to PowerBake!

Step 3: Adding an Order

Purpose: Now that we have a client and a pastry, we can start taking orders!

Lets say Luke has placed an order for 2 Croissants and 2 Apple Pies. Lets add this order to PowerBake!

First, we have to find the index of the client Luke using the command in the Command Box:

find client luke

Here we find that the index of luke is 1!

To add the order to PowerBake, use this command in the Command Box and hit Enter:

add order 1 -pn Croissant -q 2 -pn Apple Pie -q 2

This command specifies the following details about the order:

• Client: Luke using the index of the client
• Pastry: Croissant using the -pn flag
• Quantity: 2 using the -q flag

Hitting Enter will display a message indicating that the order has been successfully added to PowerBake.

You can then view the order list using the command or clicking on the order tab:

view order

You can view the order in detail by finding the order index in the GUI and typing:

view order INDEX

1. The Result Display Box will show a message indicating that the order has been successfully added.
2. The List View will display the details of the order.

Good Job! You have successfully added your first order to PowerBake! With this knowledge, you can now manage your bakery efficiently!

Step 4: Clearing PowerBake

This step is optional but if you wish to start with a clean slate, use the following command in the Command Box:

clear

^ Back to top

---

Features

This section explains the detailed list of commands and its usages which are available for you to use.

^ Back to top

---

Parameters

This section covers the different parameters used in PowerBake and their respective constraints.

^ Back to top

---

Adding a Client: add client

The add client allows you to seamlessly add key details of your client into the record. These details will then be integrated into keeping track of orders in the future.

Command Usage

add client NAME -p PHONE -a ADDRESS -e EMAIL [-t TAGS]

Parameters:

1. NAME: The name of your client.
2. -a ADDRESS: The address of your client, 5 - 100 characters
3. -e EMAIL: The email address of you client, follows valid format
4. -p PHONE: 8-digit phone number of your client
5. -t TAG: Extra details of your client

Refer to the Parameters section for more details about the parameters and their individual constraints.

Example:

Adding a client, Luke, into Powerbake application. He lives at 5 Sengkang Street and his email address is luke@gmail.com. His phone number is 88776655.

To add luke, simply type:

add client Luke -p 88776655 -a 5 Sengkang Street -e luke@gmail.com

Once enter is hit, a output message will be displayed of your success.

^ Back to top

---

Adding a Pastry: add pastry

The add pastry command allows you to add key details of pastries. These details will then utilised when keeping track of pastry orders in the future.

Command Usage

add pastry PASTRY_NAME -pr PRICE

Parameters:

1. PASTRY_NAME: The name of your pastry.
2. -pr PRICE: The price of your pastry, supports up to 2 decimal places.

Refer to the Parameters section for more details about the parameters and their individual constraints.

Example:

Adding a pastry, Croissant, into PowerBake application. Price is 5.50.

To add the Croissant, simply type

add pastry Croissant -pr 5.5

Once enter is hit, a output message will be displayed of your success.

^ Back to top

---

Adding an Order: add order

The add order command allows you to create orders for clients with their ordered pastries.

Command Usage

add order CLIENT_INDEX -pn PASTRY_NAME -q QUANTITY [-pn PASTRY_NAME -q QUANTITY]

Parameters:

1. CLIENT_INDEX: The index of the client based on the list shown
2. -pn PASTRY_NAME: The name of the pastry to be added
3. -q Quantity: The quantity of pastry to be added to the order

Refer to the Parameters section for more details about the parameters and their individual constraints.

Example:

Adding an order for client 1 an order of 10 Brownie and 20 Apple Pie into PowerBake application.

To add the Croissant, simply type

add order 1 -pn Brownie -q 10 -pn Apple Pie -q 20

Once enter is hit, a output message will be displayed of your success.

^ Back to top

---

Deleting Client, Pastry or Order: delete

The delete command helps you maintain a clean and relevant list of clients, pastries and orders.

Command Usage

delete client/pastry/order INDEX

Parameters:

1. INDEX: Represents position of the client/pastry/order list that you wish to remove.

Refer to the Parameters section for more details about the parameters and their individual constraints.

Example 1:

If you want to remove the fifth client on the list, the command would look like this:

 delete client 5

Before:

After hitting Enter, you will see the fifth client removed from the list. The remaining clients will adjust their index numbers accordingly.

After:

Example 2:

If you want to remove the second pastry on the list, the command would look like this:

 delete pastry 2

After hitting Enter, you will see the second pastry removed from the list. The remaining pastries will adjust their index numbers accordingly.

Example 3:

If you want to remove the third order on the list, the command would look like this:

 delete order 3

After hitting Enter, you will see the third order removed from the list. The remaining orders will adjust their index numbers accordingly.

^ Back to top

---

Editing Client, Pastry or Order Details : edit

The edit command offers flexibility in managing details of Clients, Pastries or Orders in PowerBake.

Command Usage

To edit Client details:

edit client INDEX [-n NAME] [-p PHONE] [-e EMAIL] [-a ADDRESS] [-t TAGS]

To edit Pastry details:

edit pastry INDEX [-n PASTRY_NAME] [-pr PRICE]

To edit Order details:

edit order INDEX -s STATUS

Parameters:

1. INDEX: Represents position of the client/pastry/order list that you wish to edit.
2. -n NAME: New name for your client/pastry that you wish to edit to
3. -p PHONE: New phone number for your client that you wish to change
4. -e EMAIL: New email for your client that you wish to use
5. -a ADDRESS: New address for your client that you wish to update
6. -t TAGS: New tags for your client to be associated with the client
7. -n PASTRY_NAME: New pastry name to be edited to
8. -pr PRICE: New price of the pastry to be updated to
9. -s STATUS: New Status of the order to be updated to

Refer to the Parameters section for more details about the parameters and their individual constraints.

Example 1:

If you want to edit the name and phone of the first client on the list, the command would look like this:

 edit client 1 -n John -p 97432170

After hitting Enter, you will see the first client edited on the list.

Example 2:

If you want to edit the price of the second pastry on the list, the command would look like this:

 edit pastry 2 -pr 9.00

After hitting Enter, you will see the second pastry updated from the list.

Example 3:

If you want to edit the status of the third order on the list, the command would look like this:

 edit order 3 -s delivered

After hitting Enter, you will see the third order updated from the list.

^ Back to top

---

Viewing Client, Pastry or Order : view

The view command offers a detailed insight of the client, pastry and order lists.

An in-depth look to access client information, types of pastries available and orders made thus far.

Command Usage

To view the various tabs:

view client/pastry/order

To view specific order:

view order INDEX

Parameters:

1. client: Access the client list.
2. pastry: Access the pastry list.
3. order: Access the order list.
4. INDEX: The order index shown on the list that you wish to view.

Refer to the Parameters section for more details about the parameters and their individual constraints.

Example 1:

If you wish to view the client details, the command would be:

 view client

After hitting Enter, you will see the client details being displayed on the GUI.

Here, you can observe all the details regarding client, such as their name, address, email address, phone number and tag.

Example 2:

If you wish to view the pastry details, the command would be:

 view pastry

After hitting Enter, you will see the pastry details being displayed on the GUI.

Here, you can observe all the details regarding pastry, such as the name and the price of the pastry.

Example 3:

If you wish to view the order details, the command would be:

 view order

After hitting Enter, you will see the order details being displayed on the GUI.

Here, you can observe the general details regarding order, such as their order number, client name, status.

Example 4:

If you wish to view the specific order details, the command would be:

 view order INDEX

After hitting Enter, you will see the order details being displayed on the GUI.

Here, you can observe all the details regarding order, such as their order number, client name, pastry name, quantity and status.

^ Back to top

---

Find Client, Pastry or Order : find

The find command is a powerful tool to help you quickly search and locate specific client/pastry/order in PowerBake.

Command Usage

find client/pastry/order KEYWORD [MORE_KEYWORDS]

Parameters:

1. client/pastry/order: Represents which type of entity you wish to find from.
2. KEYWORD: Returns searches that matches or partially matching to the keyword

Refer to the Parameters section for more details about the parameters and their individual constraints.

Example 1:

If you want to find the name of the first client on the list, the command would look like this:

find client Alex

OR

find client lex

After hitting Enter, the list will return Alex Yeoh.

Example 2:

If you want to find name of the Brownie and Apple Pie pastry on the list, the command would look like this:

find pastry Brownie Apple

After hitting Enter, the list will be updated to match the search.

Example 3:

If you want to find the order that belongs to a client on the list, the command would look like this:

find order Charlotte

After hitting Enter, you will see the only the orders that belongs to Charlotte shows up.

^ Back to top

---

Clearing all entries : clear

The clear command deletes all clients, pastries and orders in PowerBake.

Command Usage

clear

Parameters:

^ Back to top

---

Getting help : help

The help command provide popup message showing how to access this User Guide.

Command Usage

help

Parameters:

^ Back to top

---

Exiting the program : exit

The exit command lets you have a swift way of closing PowerBake.

It is a simple command, where the application terminates while safeguarding all the data and changes you have made.

Command Usage

exit

Parameters:

^ Back to top

---

Storage

This section will go through how order, pastry and customer details are stored.

Saving Data

PowerBake data is saved automatically after any command that adds, deletes or edit. There is no need for any manual saving.

Editing the Data File

CAUTION: Adding data in the wrong format could lead to potential errors.

PowerBake data is saved in [JAR file location]/data/addressbook.json, experienced users can add or delete clients and pastries within the json file.

Caution: If your changes to the data file makes its format invalid, PowerBake will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.
Furthermore, certain edits can cause the PowerBake to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.

^ Back to top

---

FAQ

Q: Do you support languages other than English?

• A: There is currently no support for languages other than English. This also means you will not be able to use non-English inputs.
  We plan to work on this in the future! Stay tuned!

Q: How do I check my Java version?

• A: Open up your command terminal and enter the following command:

java -version

You should see something like this

Q: How do I open up the command terminal?

• A:
  • Windows: open the start menu and search for cmd then press Enter
  • MacOS: open spotlight search and search for Terminal then press Enter
  • Linux press Ctrl + Alt + T to open the command terminal.

Q: How do I transfer my data to another Computer?

• A: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous PowerBake home folder.

Q: Can I use two instances of PowerBake simultaneously on the same computer?

• A: Currently we advise against using more than one instance of PowerBake at a single time as it may lead to data lost and corruption between the two instances.

^ Back to top

---

Known issues

1. When using multiple screens, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the preferences.json file created by the application before running the application again.
2. If you minimize the Help Window and then run the help command (or use the Help menu, or the keyboard shortcut F1) again, the original Help Window will remain minimized, and no new Help Window will appear. The remedy is to manually restore the minimized Help Window.

^ Back to top

---

Command summary

^ Back to top

---

Glossary

^ Back to top

---