Programming Studio Project February-June 2023

Starter code for the Studio Project. This is a simple layout connected to a GitHub Classroom that serves as the basis for implementing the studio project.

Classes backing Web pages:

├── Index.java                    - Homepages/index page. Provides a directory to all other pages
├── Page1.java                    - Sets of 6 other Java class files backing 6 other pages.
├── ...
└── Page6.java                        

Other Classes:

├── java/app                                - Package location for all Java files for the webserver
│         ├── App.java                      - Main Application entrypoint for Javalin
│         └── JDBCConnection.java           - Example JDBC Connection class based on Studio Project Workshop content
├── java/helper                             - Location of the helper file for loading SQLite with JDBC
│         └── CTGProcessCSV.java               - Helper Java program to load SQLite database from the provided CSVs

Folders:

├── /src/main                    - Location of all files as required by build configuration
│         ├── java               - Java Source location
│         │    ├── app           - Package location for all Java files for the webserver
│         │    └── helper        - Location of the helper file for loading SQLite with JDBC
│         └── resources          - Web resources (html templates / style sheets)
│               ├── css          - CSS Style-sheets. Base example style sheet (common.css) provided
│               └── images       - Image files. Base example image (RMIT Logo) provided
│ 
├── /target                      - build directory (DO NOT MODIFY)
├── /database                    - The folder to store sqlite database files (*.db files), SQL script (*.sql), and other files related to the database
├── pom.xml                      - Configure Build (DO NOT MODIFY)
└── README.md                    - This file ;)

Current Libraries:

• org.xerial.sqlite-jdbc (SQLite JDBC library)
• javalin (lightweight Java Webserver)
• thymeleaf (HTML template) - https://www.thymeleaf.org/doc/tutorials/3.0/usingthymeleaf.html

Libraries required as dependencies:

• By javalin
  • slf4j-simple (lightweight logging)
• By xerial/jdbc
  • sqlite-jdbc

Building & Running the code

There are two places code can be run from

1. The main web server program
2. the optional helper program to use JDBC to load your SQLite database from the CSVs using Java

Running the Main web server

You can run the main webserver program similar to the project workshop activities

1. Open this project within VSCode
2. Allow VSCode to read the pom.xml file

• Allow the popups to run and "say yes" to VSCode configuring the build
• Allow VSCode to download the required Java libraries

3. To Build & Run

• Open the src/main/java/app/App.java source file, and select "Run" from the pop-up above the main function

4. Go to: http://localhost:7001

DEV Container for GitHub Codespaces

The .devcontainer folder contains configuration files for GitHub Codespaces. This ensures that when the GitHub classroom is cloned, the workspace is correctly configured for Java (V16) and with the required VSCode extensions. This folder will not affect a local VSCode setup on a computer.

🚨 DO NOT MODIFY THE CONTENTS OF THIS FOLDER. 🚨

Authors

• Dr. Timothy Wiley, School of Computing Technologies, STEM College, RMIT University.

• Prof. Santha Sumanasekara, School of Computing Technologies, STEM College, RMIT University.

• Mr. Natchanon Laoharawee, RMIT University

• Mr. Russell Sheikh, RMIT University

Copyright RMIT University (c) 2023