Environment Setup
This Document is a STUB
This document may contain incomplete or false information.
FlagWar requires only two things to be built:
- Apache Maven, for managing builds and checking code compliance
- A Java Development Kit (JDK) for Java 8+
Note, both of these may be provided by your IDE. IntelliJ for example ships with Apache Maven 3, and has the option to grab from a list of available JDKs. Eclipse by comparision also provides integration for Maven via M2Eclipse, though Maven is not bundled with the integration.
Don't have a JDK or Maven installed, and using an IDE that doesn't include either? Time to grab them! See either Manual Setup on Windows or use SDKMAN!.
You might check out the SDKMAN! project, which can be used to manage both. See SDKMAN! Installation if that's the route you want to take.
For convenience's sake, the following shell commands should be all you need for a usable environment after installation.
# For specific JDK distributions, see https://sdkman.io/jdks
sdk install java
# Installs Apache Maven
sdk install mavenThe Following tools are not strictly necessary, but they do provide good workflow improvements, or may help you spot mistakes early on.
-
An Integrated Development Environment (IDE) such as Eclipse or IntelliJ IDEA
-
A Markdown (aware) editor, such as Atom Editor, Visual Studio Code, or your IDE; for writing documentation. All markdown should adhere to the GitHub Flavored Markdown (GFM) Specification.
-
An EditorConfig plugin for your IDE
-
SpotBugs - A static code analysis platform for finding bugs, dodgy code, and breaks in standard code conventions.
-
SonarLint - A static code analysis tool focused on code smells, with some overlap with SpotBugs. Integrates well with SonarQube for multiple-developer projects.
This documentation is Copyright © 2021 TownyAdvanced and licensed under a Creative Commons Attribution 4.0 International License.
