⚠️ IMPORTANT: READ THE FILE README_DB.md IN THE /db FOLDER FOR THE FULL DATABASE CONNECTION GUIDE AND TEAM INSTRUCTIONS.

⚠️ IMPORTANT: We need Maven to handle and manage dependencies (like npm node). This is not optional. For example, Java does not have native support to parse .env file so we need an external JAR. Maven just makes this simpler. Reach out to AI team if you are stuck.

1. Check if Maven is already installed:

   Open Command Prompt or PowerShell and run:

   mvn -v

2. Download Maven:

   • Go to https://maven.apache.org/download.cgi
   • Download the latest binary ZIP archive.

3. Extract Maven:

   • For example, extract to:

     C:\Program Files\apache-maven-3.9.5
     

4. Add Maven to your system PATH:

   • Add the bin directory to PATH:

     C:\Program Files\apache-maven-3.9.5\bin
     

5. Verify installation:

   mvn -v

   You should see Maven version and Java version info.

• All project dependencies are listed in pom.xml.
• Do not manually download JAR files. Maven handles them automatically.

1. Open pom.xml.

2. Add the dependency inside the <dependencies> section:

   <dependency>
       <groupId>org.example</groupId>
       <artifactId>example-lib</artifactId>
       <version>1.2.3</version>
   </dependency>

3. Fetch the dependency using:

   mvn compile

4. To view all dependencies and their hierarchy:

   mvn dependency:tree

Goal: Edit Java code and run it directly in Tomcat without creating a WAR.

1. Open Command Prompt or PowerShell and navigate to the project folder:

   cd C:\tomcat\webapps\trivia-app

2. Compile the code and download dependencies:

   mvn compile
   # OR:
   mvn clean compile # to ensure old compiled files are gone

   • Compiled .class files will be placed in:

     WEB-INF\classes\
     

3. Start Tomcat:

   cd C:\tomcat\bin
   startup.bat

4. Edit code in src\main\java\ as needed.

5. Re-run:

   cd C:\tomcat\webapps\trivia-app
   mvn compile
   # OR:
   mvn clean compile # to ensure old compiled files are gone

6. Restart Tomcat to see changes:

   cd C:\tomcat\bin
   shutdown.bat
   startup.bat

Goal: Build a clean WAR file and deploy it for hosting.

1. Build the WAR:

   cd C:\tomcat\webapps\trivia-app
   mvn clean package

   • The WAR file will be located at:

     target\trivia-app.war
     

2. Deploy the WAR to Tomcat:

   copy target\trivia-app.war C:\tomcat\webapps\

   • Do not place the WAR inside WEB-INF\classes\.
   • Tomcat will automatically unpack it and use its internal WEB-INF\classes\.

3. Start or restart Tomcat:

   cd C:\tomcat\bin
   shutdown.bat
   startup.bat

4. Access the app:

   http://localhost:8080/trivia-app
   

• Local edits → compile → restart Tomcat (local dev)
• Production deploy → build WAR → copy WAR → restart Tomcat (for hosting)

trivia-app/       ← project root (Tomcat webapp root for local dev, place this in your tomcat webapps folder)
├── WEB-INF/                                                        ← What tomcat actually understands (Ex: if you are trying to find html files route according to here)
│   ├── web.xml                                                     ← servlet configuration, BE team put your URL mappings here
│   ├── classes/com/triviaapp/servlets/                             ← (can ignore) compiled .class files go here after mvn compile
│   │               ├── CreateQuizServlet.class (for example)
│   └── lib/                                                        ← (can ignore) runtime JAR dependencies copied here by Maven
│
├── src/
│   └── main/
│       └── java/
│           └── com/
│               └── triviaapp/                                      ← Other files can go in new folders from triviaapp folder
│                   └── servlets/                                   ← BE servlets
│                       ├── CreateQuizServlet.java
│                       └── OtherServlet.java
│
├── src/main/webapp/                                                ← IMPORTANT: FE files go here (otherwise they will be git-ignored. This is required.)
│   ├── index.html
│   ├── styles.css
│   └── scripts.js
│
├── pom.xml                                                         ← Maven project file (for dependencies and project build)
└── README.md

Place a .env file in the project root (do NOT commit).
Replace username and password with your actual database credentials.

JDBC_URL=jdbc:mysql://shuttle.proxy.rlwy.net:24339/trivia_app?useSSL=true&serverTimezone=UTC
JDBC_USER=your_username
JDBC_PASS=your_password