Student Planner Application

This is Team AAAT's capstone project. Follow the instructions below to download and run the app.

Prerequisites

To run this app, you'll need to have the following software installed on your computer:

If building from source

• JDK (For building from source, version 20 or higher)
• Node.js (version 12 or higher)
• npm (version 6 or higher)
• Git
• Maven (version 3.8.1 or higher)

If using the pre-built binaries

• Java SE (version 20 or higher)

Building from source

To download the code, follow these steps:

1. Go to the GitHub repository for this app.
2. Click the "Code" button and select "Download ZIP" to download the code as a ZIP file.
3. Extract the ZIP file to a location on your computer.

Alternatively, you can clone the repository using Git:

git clone [email protected]:Team-AAAT/CanvasPlanner.git

Installing dependencies

Before you can run the app, you'll need to install its dependencies. Open a terminal or command prompt and navigate to the directory where you extracted the code.

cd /path/to/student-planner

Cd into the resources directory:

cd src/main/resources

Then, run the following command:

npm install

This will install all the necessary dependencies for the app.

Adding Java backend

Download the jar file from here and add it to the resources directory.

if you wanted to run the backend directly from the java classes supplied, use Maven to build the project.

mvn clean install

Running the app

To run the app, run the following command from the frontend directory:

npm start

This will start the Electron app. You should see a window appear with the demo GUI.

Further help

If you run into any issues or have any questions, feel free to open an issue