Skip to content

Commit

Permalink
Merge pull request #17 from mauritssilvis/restructure
Browse files Browse the repository at this point in the history
Restructure the Java projects
  • Loading branch information
mauritssilvis authored Apr 2, 2023
2 parents bb8b6fb + 23008bf commit 65336f7
Show file tree
Hide file tree
Showing 56 changed files with 14 additions and 14 deletions.
10 changes: 5 additions & 5 deletions java/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,17 @@ For others, I made use of [Maven](#112-maven).

##### Projects

* [Setting up a basic Java project using IntelliJ IDEA](basic_java_project_intellij)
* [Setting up a basic Java project using IntelliJ IDEA](basic-java-project-intellij)

#### 1.1.2 Maven

##### Projects

* [Setting up a basic Maven project using IntelliJ IDEA](basic_maven_project_intellij)
* [Setting up a basic Maven project using IntelliJ IDEA](basic-maven-project-intellij)

##### JARs

* [Creating an executable JAR using Maven](executable_jar_maven_intellij)
* [Creating an executable JAR using Maven](executable-jar-maven-intellij)

## 2. Background

Expand All @@ -58,15 +58,15 @@ This IDE supports Java and several other JVM languages and can be extended with
IntelliJ IDEA has [detailed online documentation](https://www.jetbrains.com/help/idea/discover-intellij-idea.html), and its [community edition](https://www.jetbrains.com/idea/download/) can be downloaded and used for free.

IntelliJ IDEA makes it easy to configure code styles, automatic copyright notices, code inspection profiles, run configurations and more.
The basic IntelliJ IDEA configuration used in the above-mentioned projects is described in the [IntelliJ IDEA section](basic_java_project_intellij#12-intellij-idea) of [Setting up a basic Java project using IntelliJ IDEA](basic_java_project_intellij).
The basic IntelliJ IDEA configuration used in the above-mentioned projects is described in the [IntelliJ IDEA section](basic-java-project-intellij#12-intellij-idea) of [Setting up a basic Java project using IntelliJ IDEA](basic-java-project-intellij).

### 2.3 Maven

[Maven](https://maven.apache.org/) is a build tool that can be used to manage and build projects written in Java and other programming languages.
The [project object model](https://maven.apache.org/guides/introduction/introduction-to-the-pom.html), a file named `pom.xml`, is central to using Maven.
In this file, the project properties can be set, build plugins can be configured, project dependencies can be defined, etc.

The basic Maven configuration used in the above-mentioned projects is discussed in the [Maven section](basic_maven_project_intellij#13-maven) of [Setting up a basic Maven project using IntelliJ IDEA](basic_maven_project_intellij).
The basic Maven configuration used in the above-mentioned projects is discussed in the [Maven section](basic-maven-project-intellij#13-maven) of [Setting up a basic Maven project using IntelliJ IDEA](basic-maven-project-intellij).
A step-by-step guide for setting up a Maven project using IntelliJ IDEA can be found in the [Maven section](https://www.jetbrains.com/help/idea/maven-support.html#create_new_maven_project) of IntelliJ IDEA's [online documentation](https://www.jetbrains.com/help/idea/discover-intellij-idea.html).

## License
Expand Down
File renamed without changes.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ With this part of the [Challenges](https://github.com/mauritssilvis/challenges)
Below, I give detailed [background information](#1-background) on the project's [code](#11-java), [IntelliJ IDEA's configuration](#12-intellij-idea) and the used [Maven configuration](#13-maven).
I also describe several [issues](#2-issues-and-solutions) that can occur when setting up a Maven project, for which I provide possible solutions.

This project builds on [Setting up a basic Java project using IntelliJ IDEA](https://github.com/mauritssilvis/challenges/tree/main/java/basic_java_project_intellij).
This project builds on [Setting up a basic Java project using IntelliJ IDEA](https://github.com/mauritssilvis/challenges/tree/main/java/basic-java-project-intellij).

## 1. Background

Expand All @@ -31,7 +31,7 @@ public class Main {

### 1.2 IntelliJ IDEA

The basic configuration of this project is described in the [IntelliJ IDEA section](https://github.com/mauritssilvis/challenges/tree/main/java/basic_java_project_intellij#12-intellij-idea) of [Setting up a basic Java project using IntelliJ IDEA](https://github.com/mauritssilvis/challenges/tree/main/java/basic_java_project_intellij).
The basic configuration of this project is described in the [IntelliJ IDEA section](https://github.com/mauritssilvis/challenges/tree/main/java/basic-java-project-intellij#12-intellij-idea) of [Setting up a basic Java project using IntelliJ IDEA](https://github.com/mauritssilvis/challenges/tree/main/java/basic-java-project-intellij).
Additional details regarding the IntelliJ IDEA run configurations of the current project are given in what follows.

#### 1.2.1 Configuration
Expand Down Expand Up @@ -504,7 +504,7 @@ When trying to execute a JAR, an error similar to the following may occur:
no main manifest attribute, in basic-1.0-SNAPSHOT.jar
```

To solve this problem, configure the Maven JAR plugin according to the discussion of potential [Maven JAR plugin issues](https://github.com/mauritssilvis/challenges/tree/main/java/executable_jar_maven_intellij#21-maven-jar-plugin-issues) that is part of [Creating an executable JAR using Maven](https://github.com/mauritssilvis/challenges/tree/main/java/executable_jar_maven_intellij).
To solve this problem, configure the Maven JAR plugin according to the discussion of potential [Maven JAR plugin issues](https://github.com/mauritssilvis/challenges/tree/main/java/executable-jar-maven-intellij#21-maven-jar-plugin-issues) that is part of [Creating an executable JAR using Maven](https://github.com/mauritssilvis/challenges/tree/main/java/executable-jar-maven-intellij).

## License

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ With this part of the [Challenges](https://github.com/mauritssilvis/challenges)
Below, I give [background information](#1-background) on the project's [code](#11-java), [IntelliJ IDEA's configuration](#12-intellij-idea) and the used [Maven configuration](#13-maven).
I also detail some [issues](#2-issues-and-solutions) that can occur when creating an executable JAR using Maven, for which I provide possible solutions.

This project builds on [Setting up a basic Java project using IntelliJ IDEA](https://github.com/mauritssilvis/challenges/tree/main/java/basic_java_project_intellij) and [Setting up a basic Maven project using IntelliJ IDEA](https://github.com/mauritssilvis/challenges/tree/main/java/basic_maven_project_intellij).
This project builds on [Setting up a basic Java project using IntelliJ IDEA](https://github.com/mauritssilvis/challenges/tree/main/java/basic-java-project-intellij) and [Setting up a basic Maven project using IntelliJ IDEA](https://github.com/mauritssilvis/challenges/tree/main/java/basic-maven-project-intellij).

## 1. Background

Expand All @@ -31,7 +31,7 @@ public class Main {

### 1.2 IntelliJ IDEA

The basic configuration of this project is described in the [IntelliJ IDEA section](https://github.com/mauritssilvis/challenges/tree/main/java/basic_java_project_intellij#12-intellij-idea) of [Setting up a basic Java project using IntelliJ IDEA](https://github.com/mauritssilvis/challenges/tree/main/java/basic_java_project_intellij).
The basic configuration of this project is described in the [IntelliJ IDEA section](https://github.com/mauritssilvis/challenges/tree/main/java/basic-java-project-intellij#12-intellij-idea) of [Setting up a basic Java project using IntelliJ IDEA](https://github.com/mauritssilvis/challenges/tree/main/java/basic-java-project-intellij).
Additional details regarding the IntelliJ IDEA run configurations of the current project are given in what follows.

#### 1.2.1 Configuration
Expand All @@ -44,7 +44,7 @@ The other two run configurations, respectively, create a JAR and execute it.

### 1.3 Maven

The configuration used in this project extends the [Maven configuration](https://github.com/mauritssilvis/challenges/tree/main/java/basic_maven_project_intellij#13-maven) of [Setting up a basic Maven project using IntelliJ IDEA](https://github.com/mauritssilvis/challenges/tree/main/java/basic_maven_project_intellij).
The configuration used in this project extends the [Maven configuration](https://github.com/mauritssilvis/challenges/tree/main/java/basic-maven-project-intellij#13-maven) of [Setting up a basic Maven project using IntelliJ IDEA](https://github.com/mauritssilvis/challenges/tree/main/java/basic-maven-project-intellij).
Additional details regarding the Maven configuration of the current project are given in what follows.

#### 1.3.1 Configuration
Expand Down Expand Up @@ -93,7 +93,7 @@ mvn clean install
## 2. Issues and solutions

While setting up and building a Maven project, several issues may occur.
I partly documented these issues in the [Issues and solutions section](https://github.com/mauritssilvis/challenges/tree/main/java/basic_maven_project_intellij#2-issues-and-solutions) of [Setting up a basic Maven project using IntelliJ IDEA](https://github.com/mauritssilvis/challenges/tree/main/java/basic_maven_project_intellij).
I partly documented these issues in the [Issues and solutions section](https://github.com/mauritssilvis/challenges/tree/main/java/basic-maven-project-intellij#2-issues-and-solutions) of [Setting up a basic Maven project using IntelliJ IDEA](https://github.com/mauritssilvis/challenges/tree/main/java/basic-maven-project-intellij).

Additional problems may occur when trying to execute a JAR created using Maven.
Below, I describe the issues related to the [Maven JAR plugin](#21-maven-jar-plugin-issues), including possible solutions.
Expand Down
File renamed without changes.

0 comments on commit 65336f7

Please sign in to comment.