/hwr-oop-project-template

Primary LanguageJavaMIT LicenseMIT

HWR OOP Lecture Project Template

This repository contains a student project created for an ongoing lecture on object-oriented programming with Java/Kotlin at HWR Berlin (summer term 2024).

⚠️ This code is for educational purposes only. Do not rely on it!

Prerequisites

Installed:

  1. IDE of your choice (e.g. IntelliJ IDEA)
  2. JDK of choice installed (e.g. through IntelliJ IDEA)
  3. Maven installed (e.g. through IntelliJ IDEA)
  4. Git installed

Local Development

This project uses Apache Maven as build tool.

To build from your shell (without an additional local installation of Maven), ensure that ./mvnw is executable:

chmod +x ./mvnw

I recommend not to dive into details about Maven at the beginning. Instead, you can use just to build the project. It reads the repositories justfile which maps simplified commands to corresponding sensible Maven calls.

With just installed, you can simply run this command to perform a build of this project and run all of its tests:

just build

Abstract

Feature List

Number Feature Tests
1 / /

Additional Dependencies

Number Dependency Name Dependency Description Why is it necessary?
1 / / /

Instructions

Use a fork of this repository to do implement your project.

Remember to add this repository as a second remote repository (upstream) and pull from the correct remotes. This is necessary, because we might apply changes to this template during the next month.

The following section describes how to add multiple remote repositories to your local repository, which is cloned from the fork.

Multiple remote repositories

Your local repository should have a reference to both the fork (your own remote repository) and the original remote repository. To configure your git remote repositories, use the git remote command set.

  1. Clone your fork and go enter the repository.
git clone <fork-url>
cd <created-folder>
  1. Now your fork is configured as primary remote repository (origin). Next to origin, you should add the original repository as a second remote repository (upstream).
git remote add upstream <repository-url>
  1. Verify that both remotes are configured correctly. The following command should list both remotes: origin and upstream.
git remote -v
  1. To fetch changes from all remote repositories, use:
git fetch --all
  1. If there are interesting changes (in e.g. the main branch) to merge into your branch, use:
git pull upstream main