yuaaa-n / edusave-bank

EBU6304 - Software Engineering - 2023/24 Group Project

EduSave-Bank

EBU6304 - Software Engineering - 2023/24 Group Project

Welcome to the EduSave Bank software documentation. This platform is designed to facilitate interactive financial education for children, parents, and educators through engaging interfaces and real-time functionalities.

Prerequisites

Before starting, ensure you have:

• Installed the latest version of Java (at least Java 8)
• Access to a modern web browser like Google Chrome or Mozilla Firefox

Installation

1. Clone or download the repository: (Instructions to clone or download will be provided by your usual method of software distribution.)

2. Import the project into your IDE (Optional):

   • If you prefer to use an Integrated Development Environment (IDE) for Java like IntelliJ IDEA or Eclipse, you can import the project for easier management and development.

3. Install any required libraries or dependencies:

   • Check the lib/ directory in the project root for any library files that need to be included in the project's classpath.

Compiling the Software

Navigate to the directory containing your source files and compile the MainGUI.java file using the Java compiler:

javac MainGUI.java

This command compiles MainGUI.java and any other files it depends on.

Running the Software

After compilation, run the program using:

java MainGUI

This command starts the main GUI of the EduSave Bank application.

Using the Software

• Parent Interface: Log in to view and manage your child’s account and assign tasks.
• Child Interface: Log in to view account details, complete tasks, and learn about financial management.
• Educator Interface: Access tools for setting up educational content and tracking student progress.

Troubleshooting

If you encounter any issues:

1. Ensure all source files are compiled without errors.
2. Check the logs/ directory for error logs.
3. Restart the application if configuration changes are made.

Contributing

Contributions are welcome! Feel free to improve existing features or suggest new ones.

License

This software is licensed under the MIT License. For more information, see the LICENSE file in the project root.

For further assistance, please contact [email protected].