Welcome to the KrustyKrab

For all restaurant staff folks who struggle with keeping track of who's coming to eat.

This is a CLI-based bookings tracker which helps in keeping track of booking details and customer information in a simple, efficient, and centralized system for quick and easy management.

This project is based on the AddressBook-Level3 project created by the SE-EDU initiative.

How does it help?

If you're wasting time, you're wasting money... and that's just sick.

~ Mr Krabs

KrustyKrab provides restaurant staff with a centralised platform that allows them to keep track of both customers and their bookings, with an easy command-based interface to allow staff to:

Customer Commands

• Add customers
• Edit customers
• Delete customers
• Find customers by keyword
• List all customers
• Clear all customers

Booking Commands

• Add bookings
• Edit bookings
• Delete bookings
• Clear all completed/cancelled bookings
• Filter bookings by phone number/date/booking status
• Mark bookings as completed/cancelled/upcoming
• Display all bookings
• Display all upcoming bookings
• Summarise bookings of the day

Getting started

Download our Jar file

You can find our Jar file under Releases. Download the latest one and test it out!

Forking the Repo

1. Navigate to the repository on GitHub: AY2425S2-CS2103T-T08-2/tp.
2. Click on the "Fork" button at the top right corner of the page to create a copy of the repository under your own GitHub account.
3. Clone the forked repository to your local machine using the following command:

git clone https://github.com/YOUR_USERNAME/tp.git

4. Navigate into the project directory:

cd tp

5. Set up the upstream remote to keep your fork in sync with the original repository:

git remote add upstream https://github.com/AY2425S2-CS2103T-T08-2/tp.git

Building the Project

1. Ensure you have Java 17 or above installed on your machine.
2. Open a terminal and navigate to the project directory.
3. Build the project using Gradle:

./gradlew build

4. Run the application:

./gradlew run

Running Tests

1. To run all tests, use the following command:

./gradlew test

Additional Setup

For more detailed setup instructions, refer to the Developer Guide.

Getting help with KrustyKrab

W-well, I uh... oh barnacles...

~ Mr Krabs

Feel free to check out our website to clarify any issues you may have.

In the event that that's not enough, feel free to reach out to our development team!

The Dev Team

Jaylon Tan

Data Developer
Avid Spongebob lover

Benjamin Koh

Team Lead
Would like everyone to know he created Gyatword.com

Lu "Bloin" Bolin

Team Lead
Has been coding since 2 years old

Wang Yanxiang

Code Quality Connoisseur
Here for diversity

Patrick Thomas

UI/UX Undertaker
Does not live under a rock in bikini bottom