Skip to content

danielcregg/ooc2-project-template-gitpod

Repository files navigation

OOC2 Project Template (Gitpod)

Java License: MIT

A ready-to-use JavaFX project template for the Object-Oriented Computing 2 (OOC2) final project, pre-configured for Gitpod cloud development.

Overview

This repository provides a starter template for OOC2 students at Atlantic Technological University (ATU). It includes a minimal JavaFX application, Gitpod configuration with a VNC-enabled workspace for GUI rendering, build scripts, and a structured README outline for project documentation. Students fork this template and build their own item management application on top of it.

Features

  • JavaFX Starter App -- A minimal "Hello World" JavaFX application to build upon
  • Gitpod Integration -- One-click cloud IDE with VNC desktop for GUI applications
  • Custom Dockerfile -- Pre-installed OpenJFX and Zulu JDK with JavaFX support
  • Build Script -- Shell script to compile and run the application in Gitpod
  • Resource Directory -- Pre-configured folder for serialization and data files
  • README Template -- Structured documentation outline for project submissions

Prerequisites

  • A GitHub account
  • A Gitpod account (free tier available) or a local Java development environment
  • Java 11 or later with JavaFX support (for local development)

Getting Started

Installation

Option A -- Gitpod (Recommended):

Open in Gitpod

Option B -- Local Clone:

git clone https://github.com/danielcregg/ooc2-project-template-gitpod.git
cd ooc2-project-template-gitpod

Usage

In Gitpod:

Run the build script from the terminal:

bash buildRun.sh

The application will compile and launch in the Gitpod VNC preview window on port 6080.

Locally:

javac -d bin src/ie/gmit/mypackage/*.java
java -cp bin ie.gmit.mypackage.Main

Tech Stack

  • Language: Java 11+
  • GUI Framework: JavaFX (OpenJFX)
  • Cloud IDE: Gitpod (VNC-enabled workspace)
  • Container: Custom Docker image based on gitpod/workspace-full-vnc

License

This project is licensed under the MIT License. See the LICENSE file for details.

About

JavaFX project starter template for OOC2 final projects at ATU, pre-configured with Gitpod VNC workspace and build scripts

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors