Crossroads

Members

Name	Student Id
Alexandre Catellier	40281048
Duc Vinh Lam	40282959
Mathieu Choueiry	40284714
Elliot Vinet	40210063
Arturo Sanchez E	40283236
William Ross	40296710

Diagrams

Head to the README.md to view some of the project diagrams.

Running instructions

This project is best run on VSCode using bun.js and the "Local Development" launch configuration. Nonetheless, it's possible to run it using other popular package managers like npm, and a Java IDE like Intellij Idea.

Using npm

1. Download npm (bundled with node.js, installation steps)
2. Set directory to frontend/ by running cd frontend. Install dependencies by running npm install.
3. Download and configure a JDK compatible with JDK 21.

Continue to either "VSCode" or "Intellij Idea".

Using bun.js (preferred)

1. Download bun: installation steps
2. Install dependencies by running bun install.
3. Download and configure a JDK compatible with JDK 21.

Continue to either "VSCode" or "Intellij Idea".

VSCode

4. If using VSCode, you can use the launch configurations. "Local Development" runs both the frontend and the backend.
5. Access the frontend at http://localhost:5173

IntelliJ Idea

4. If using Intellij, you'll want to run the backend by running the Application.java file, found at \backend\src\main\java\org\crossroads\Domain\Application.java
5. Use the terminal to run bun run dev (if bun is installed) or cd frontend && npm run dev (if npm is installed) to run the frontend.
6. Access the frontend at http://localhost:5173

CLI

It is possible to run the project with a single terminal command (ran at the root.)

Preconditions: bun is installed, and frontend dependencies are installed via bun install.

bun run both