Fastfood Ordering and Management System Application

The Fastfood Ordering and Management System (FOMS) Application enhances fast food restaurant operations by facilitating menu management, order placement, and payment processing. It provides real-time order tracking for customers and allows staff and managers to efficiently handle orders and menu updates. Additionally, admins can oversee company and staff management. This README file provides detailed instructions on how to clone, compile, and run the application, ensuring users can easily set up and navigate the system.

Links:

UML Class Diagram | Report | JavaDocs

Team Members

Name	GitHub Account
Sally Ngui Yu Ying	acrylicruler
Shingamu Sai Ajay	Sai-Ajay
Zhang Xinyang	thenewgoat
Shen Jia Cheng	shenjc01
Sharanya Basu	SHAR0094

FOMS Set-Up Instructions

Compiling and Running the Code

Using the terminal

These setup instructions will guide you through the process of cloning the repository, navigating to the cloned repository, compiling the project, and running the project in your terminal.

1. Open your terminal

2. Clone the repository by entering the following command:

   git clone https://github.com/Sai-Ajay/SC2002-OOP-FOMS-2.0.git

3. Navigate to the cloned repository by entering the following command:

   cd SC2002-OOP-FOMS-2.0

4. Compile the project by entering the following command:

   javac -cp foms/src -d bin foms/src/main/FomsApp.java

5. Run the project by entering the following command:

   java -cp bin main.FomsApp

Congratulations, you have successfully cloned, compiled, and run the FOMS project!

Generating Javadocs

Using the terminal

Follow the steps below to generate JavaDocs using the terminal:

1. Open your terminal.

2. Navigate to the root directory of the project. Or enter the following command.

   cd SC2002-OOP-FOMS-2.0/foms/src

3. Run the following command in the terminal:

    javadoc -d ../docs -author -private -noqualifier all -version "controllers" "enums" "interfaces" "main" "models" "services" "stores" "test" "utils" "utils.exceptions" "views"

   This command will generate the JavaDocs and save them in the docs directory in HTML format.

4. Navigate to the docs directory using the following command:

   cd ../docs

5. Open the index.html file in a web browser to view the generated JavaDocs.

Congratulations, you have successfully created and viewed the JavaDocs.

Accessing Data Files

The data files used for system initialisation can be found in foms/data. 3 CSV files are used for initialisation:

1. staff_list.csv

   Contains full list of all staff, managers and admin.

2. branch_list.csv

   Contains full list of all initial branches.

3. menu_list.csv

   Contains full list of all initial menu items and the respective branches where they can be found.

Usage

Login Credentials

In this section you can find some of the login credentials for users with different roles. The full list of usernames is available in foms/data/staff_list.csv, and the password defaults to 'password' for first login.

# Staff
USERID: MaryL
PASSWORD: password

# Manager
USERID: TomC
PASSWORD: password

# Admin
USERID: boss
PASSWORD: password