Project

General

Profile

Getting Started » History » Version 5

Hans-Martin Haase, 08/11/2015 04:29 PM
Add configuration and further reading information

1 1 Johannes Schmölz
h1. Getting Started
2
3
This guide will give you a short briefing of how to get your development environment up and running within a few minutes.
4
5
6
h2. Basic Setup
7
8 4 Hans-Martin Haase
For the basic setup of your development environment you need to obtain the following tools and programs:
9 1 Johannes Schmölz
10 4 Hans-Martin Haase
* The "Java Development Kit":http://www.oracle.com/technetwork/java/javase/downloads/index.html (JDK) version 7 or higher
11 1 Johannes Schmölz
* A text editor or an IDE
12 4 Hans-Martin Haase
* "Maven":http://maven.apache.org/ version 3.0.5 or higher
13 1 Johannes Schmölz
* "Git":http://git-scm.com/
14 4 Hans-Martin Haase
* Optional the Android SDK if you want to help developing the Android client
15 1 Johannes Schmölz
16 2 Johannes Schmölz
Since the setup process of the development environment is dependent on the operating system used, you will find the instructions for different systems (Windows, OS X and Linux) below.
17 1 Johannes Schmölz
18
19
h3. Windows
20
21 2 Johannes Schmölz
# Download and install the "Java Development Kit":http://www.oracle.com/technetwork/java/javase/downloads/index.html
22 4 Hans-Martin Haase
Version 7 of the JDK is sufficient, but we strongly recommend to use the most recent version.
23 1 Johannes Schmölz
# Get an editor or an IDE of your choice and install it
24 2 Johannes Schmölz
Good IDEs for Java development are "NetBeans":http://www.netbeans.org/ and "Eclipse":http://www.eclipse.org/. If you prefer a pure text editor, "Notepad++":http://notepad-plus-plus.org/ is worth trying.
25 3 Johannes Schmölz
# Download and install the most recent version of "Maven":http://maven.apache.org/
26 2 Johannes Schmölz
# Download "Git":http://git-scm.com/.
27
There are different options available in order to use Git on Windows:
28 4 Hans-Martin Haase
* "Git Extensions":http://gitextensions.github.io/
29
Git Extensions is a graphical user interface for Git, that comes with Windows Explorer integration. It is based on "MSysGit":http://msysgit.github.io/. Our recommendation for Windows users.
30
* "TortoiseGit":https://tortoisegit.org
31
TortoiseGit is a port of TortoiseSVN. For those familiar with TortoiseSVN, TortoiseGit is worth trying. It requires "MSysGit":http://msysgit.github.io/.
32
* "MSysGit":http://msysgit.github.io/
33 1 Johannes Schmölz
Git on the command line.
34 2 Johannes Schmölz
35 1 Johannes Schmölz
You are done!
36
37 3 Johannes Schmölz
38 1 Johannes Schmölz
h3. OS X
39
40 4 Hans-Martin Haase
On OS X you may use "homebrew":http://homebrew.sh to install the latest version of Git and Maven. An IDE or editor package have to be downloaded from the corresponding project page if there is no version available in the AppStore.
41
The JDK should be downloaded directly from the Oracle page "here":http://www.oracle.com/technetwork/java/javase/downloads/index.html.
42 1 Johannes Schmölz
43 4 Hans-Martin Haase
You are done!
44 1 Johannes Schmölz
45
h3. Linux
46
47 4 Hans-Martin Haase
On Linux you can use your system's package manager to install all required tools and programs. Below you will find the commands to do so, based on "aptitude":http://packages.debian.org/aptitude, a front-end for "Debian's":http://www.debian.org "Advanced Package Tool":http://wiki.debian.org/Apt (APT).
48 3 Johannes Schmölz
49
# Install "OpenJDK":http://openjdk.java.net/
50
OpenJDK 7: @sudo aptitude install openjdk-7-jdk@
51 4 Hans-Martin Haase
OpenJDK 8: @sudo aptitude install openjdk-8-jdk@
52
If you prefer the Oracle JDK, you have to download and install it manually. You can get it from "here":http://www.oracle.com/technetwork/java/javase/downloads/index.html.
53 3 Johannes Schmölz
# Install an editor or an IDE of your choice
54
If you want to use a plain text editor, we recommend "Emacs":https://www.gnu.org/software/emacs/: @sudo aptitude install emacs@
55
"NetBeans":http://www.netbeans.org/: @sudo aptitude install netbeans@
56
"Eclipse":http://www.eclipse.org: @sudo aptitude install eclipse@
57
*Note:* If you want to use the most recent version of "NetBeans":http://www.netbeans.org/ or "Eclipse":http://www.eclipse.org, which is recommended, you should obtain the installer packages from the official websites and perform a manual installation.
58
# Install "Maven":http://maven.apache.org/
59
@sudo aptitude install maven@
60
# Install "Git":http://git-scm.com/
61
@sudo aptitude install git@
62
63
You are done!
64 1 Johannes Schmölz
65
66
h2. Configuration
67
68 5 Hans-Martin Haase
In order to get started with the development we need the code to work with. The public repository with the source code is located at https://github.com/ecsec/open-ecard which needs to be cloned. How to clone a repository depends on the git integration in the used IDE or editor. The general process on the command line is as follows and should be the same on all platforms.
69 1 Johannes Schmölz
70 5 Hans-Martin Haase
# Clone the repository
71
@git clone https://github.com/ecsec/open-ecard.git@
72
# Switch into the source directory
73
@cd open-ecard@
74
# Initialize and clone the BouncyCastle submodule 
75
@git submodule update --init@
76 1 Johannes Schmölz
77 5 Hans-Martin Haase
You may now open the project in your preferred IDE or editor and start developing but be sure to have read the necessary documents regarding the development and contributions to the project.
78
79 1 Johannes Schmölz
h2. Further Reading
80
81 5 Hans-Martin Haase
This section contains a collection of links to topics which are also relevant for the development process.
82
83
* [[code-style|Code Style Guideline]]: Information about code formatting, Javadoc creation.
84
* [[Repository Guidelines]]: Detailed information about the repository, their usage and commit rules.