Skip to content

Latest commit

 

History

History
98 lines (63 loc) · 3.51 KB

INSTALL.md

File metadata and controls

98 lines (63 loc) · 3.51 KB

Lernstick Storage Media Management Setup

GitLab pipeline status

This is a work in progress project for a new version of the DebianLiveCopy application.

[[TOC]]

Prerequisites

This application is designed to run in the Lernstick environment.

Please setup a Lernstick environment first on a dedicated media or in a virtual machine (recommend).

Git

First, make sure that your Git configuration works in Lernstick and that you have added your SSH public keys to your account.

Additional packages

We require the following additional packages:

sudo apt update
sudo apt install --no-install-recommends -y checkstyle gradle openjdk-11-jdk openjfx

Source code

Choose any directory (e.g. ~/NetBeansProjects) and clone the project and its dependencies:

mkdir -p ~/NetBeansProjects
cd ~/NetBeansProjects
git clone https://github.com/Lernstick/lernstickTools
git clone https://github.com/Lernstick/jbackpack
git clone [email protected]:ip34-21vt/ip34-21vt_lernstick/storage-media-management.git

Note: All repositories must be cloned to the same parent directory.

Build & Run

Note: This works only on the develop branch but not yet on master.

Enter the project directory (e.g. cd ~/NetBeansProjects/storage-media-management) and give it a try:

cd ~/NetBeansProjects/lernstickTools
gradle jar
cd ~/NetBeansProjects/storage-media-management
ant jar

And to start the application:

cd ~/NetBeansProjects/storage-media-management
ant run

Development

The project was initially build using Apache NetBeans. Therefore this is the easiest way to start coding on the project.

NetBeans

It's strongly recommend to get the latest release before starting. Unfortunately they are not packaged for Debian, but you can get the latest release from their website. Follow the instructions in their installer.

To import the project use "Open Project" and...

  1. ...select the lernstickTools folder
  2. agree to resolve the project problem by setting up Gradle
  3. ...select the jbackpack folder
  4. agree to install the nb-javac plugin and follow the instructions in the wizard
  5. ...select the storage-media-management folder
  6. ignore the dialog about the missing openjfx library (this is a false positive)
  7. verify that you can build and run the project in NetBeans
  8. hack & profit.

Scene Builder

We use the JavaFX Scene Builder to build the graphical user interface.

sudo apt update
sudo apt install --no-install-recommends -y scenebuilder

The FXML files are located in src/main/resources/fxml, the corresponding code in src/main/java/ch/fhnw/dlcopy/gui/javafx.

Guidelines & Testing

Our guidelines and procedure can be found in the Construction section of our project wiki. Our project management and issue tracker is here.