xJQx / sc2002-fypms

A Java-based application for managing final year projects (FYP) for students in tertiary institutions.

Final Year Project Management System

Team: Jing Qiang | Jing Hua | Trini

Docs: Report | UML Class Diagram | Java Docs

A Java-based application for managing final year projects (FYP) for students in tertiary institutions. It features authentication, user management, project management, and communications between students, supervisors, and fyp coordinators. This README file provides instructions on how to clone, compile, and run the project.

Table of Contents

• Final Year Project Management System
  • Table of Contents
• FYPMS setup instructions
  • Compiling and Running the project
    • Using the terminal
    • Using Eclipse
  • Generating JavaDocs
    • Using the terminal
    • Using Eclipse
• Usage
  • Login Credentials

FYPMS setup instructions

Compiling and Running the project

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/xJQx/sc2002-fypms.git

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

   cd sc2002-fypms

4. Compile the project by entering the following command:

   javac -cp src -d bin src/main/FypmsApp.java

5. Run the project by entering the following command:

   java -cp bin main.FypmsApp

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

Using Eclipse

If you prefer to use Eclipse as your IDE, you can also set up the project there. Here are the steps you need to follow:

1. Open Eclipse

2. Click on File > Import > Git > Projects from Git > Clone URI

3. In the Clone URI window, paste the following URL:

   https://github.com/xJQx/sc2002-fypms.git

4. Click Next and follow the prompts to finish the cloning process

5. Once the project is cloned, right-click on the project folder and select Properties

6. In the Properties window, click on Java Build Path > Source > Add Folder

7. Select the src folder from the project directory and click OK

8. Now you can run the project by right-clicking on FypmsApp.java in the src/main folder and selecting Run As > Java Application

That's it! You should now have the project up and running in Eclipse.

Generating JavaDocs

Using the terminal

Follow the steps below to generate JavaDocs using the terminal:

1. Open you terminal.

2. Navigate to the root directory of the project.

3. Run the following command in the terminal:

    javadoc -d docs -sourcepath src -subpackages controllers:enums:interfaces:main:models:services:stores:utils:views -private

   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.

Using Eclipse

1. Open the Eclipse IDE and open your Java project.

2. Select the package or class for which you want to generate JavaDocs.

3. Go to the "Project" menu and select "Generate Javadoc".

4. In the "Generate Javadoc" dialog box, select the "Private" option to generate JavaDocs for private classes and members.

5. Choose the destination folder where you want to save the generated JavaDocs.

6. In the "Javadoc command line arguments" field, add any additional arguments that you want to include, such as -classpath.

7. Click the "Finish" button to start the JavaDocs generation process.

8. Once the JavaDocs have been generated, you can view them by opening the index.html file in your web browser.

Congratulations, you have successfully created and viewed the JavaDocs.

Usage

Login Credentials

This section contains some login credentials for users with different roles. The full list is available in data/user.csv file.

Students:

# Student 1
USERID: YCHERN
PASSWORD: password

# Student 2
USERID: KOH1
PASSWORD: password

# Student 3
USERID: CT113
PASSWORD: password

Supervisors:

# Supervisor 1
USERID: BOAN
PASSWORD: password

# Supervisor 2
USERID: LIMO
PASSWORD: password

FYP Coordinator:

# FYP Coordinator 1
USERID: ASFLI
PASSWORD: password