Tooling

The following tooling is recommended.

• JDK 8 (latest version)
• Maven (latest 3.x version)
• Java IDE
  • IntelliJ (latest version)
    or
  • Eclipse (latest version)
• Angular IDE
  • IntelliJ (latest version)
    or
  • Visual Studio Code
    or
  • any other Editor like Notepad++
• Git Client
  • Command Line Interface (CLI)
    
    • Cmder With git-for-windows (Windows)
    • Use your package manager to install "git" (Unix)
  • Graphical User Interface
    
    • Git Extensions (Windows)
      or
    • Source Tree (Windows)
• Node.js (version 6.x)

Optional

• REST Client (to call the backend manually)
  
  • Postman (see backend/Educama-Backend.postman_collection.json)

Source

Checking out the code

1. Create an account on https://github.com/

2. Create a remote fork of https://github.com/Educama/Showcase

   Fork A Repo (Github Help)

   see https://help.github.com/articles/fork-a-repo/

3. Install Git

   
   

4. Create a local clone

   git clone https://github.com/<yourname>/Showcase.git

   
   

5. Create a remote for the upstream project so that it is later easier to retrieve changes from the main repository.

   cd Showcase
   git remote add upstream https://github.com/Educama/Showcase.git

Compile and start the application 

Backend

Pre-Requisites

• Set JAVA_HOME to a Java 8 JDK
  

  Hint for Windows

  Computer > Properties > Advanced Settings > Environment Variables > System Variables

  
  

If you have a Camunda Enterprise Edition License key you can integrate the Camunda EE Cockpit App. Configure the file "~./m2/settings.xml" as follows (or merge it into the existing file if it already exists):

<?xml version="1.0" encoding="UTF-8"?>
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
  <servers>
	<server>
      <id>camunda-bpm-nexus</id>
      <username>{to be filled}</username>
      <password>{to be filled}</password>
    </server>
  </servers>
</settings>

Then you can build with 

./mvnw clean install -P enterprise

in the directory "backend" the full package with the Camunda EE Cockpit App.

API Gateway

Frontend

Pre-Requisites

• Install Node.js and update PATH to include the "bin" directory of the node installation
• Install Gulp Command Line Interface with "npm install --global gulp-cli"
  

Flight Information Service

Pre-Requisites

• Set JAVA_HOME to a Java 8 JDK

• Local MongoDB on port 27017

  Hint for Windows

  Computer > Properties > Advanced Settings > Environment Variables > System Variables

Acceptance-Tests

1. Install/Unzip Portable Firefox in Version 42 
   1. Download Portable Firefox 42 for Linux
   2. Download Portable Firefox 42 for Windows
      
   3. Download Portable Firefox 42 for Mac (not tested yet)
      
2. Run the Tests:
   Unix:
   cd Showcase/acceptance-tests
./mvnw clean verify -Dwebdriver.firefox.bin="PATH_TO_FIREFOX/firefox-bin"
   
   Windows:
   cd Showcase\acceptance-tests
mvnw.cmd clean verify -Dwebdriver.firefox.bin="PATH_TO_FIREFOX\FirefoxPortable.exe"

The results can be viewed in a browser by opening Showcase/acceptance-tests/target/site/serenity/index.html after having executed the tests.

Open Project in IDE

The repository contains three main directories which can be edited using an IDE.

Eclipse

If you use Eclipse for Java Development then please configure it to use spaces instead of tabs:

1. Click Window→ Preferences
2. Expand Java→Code Style
3. Click Formatter
4. Click the Edit button
5. Click the Indentation tab
6. Under General Settings, set Tab policy to: Spaces only
7. Set an explicit Profile Name at the top of the dialog (this enables the OK Button)
8. Click OK to apply the changes.

IntelliJ

The run configuration of npm project does not show up in the run dashboard of IntelliJ by default. If you want to seem add them to the available configurations:

• Go to "Run" → "Edit Configurations"
• Select "Defaults"
• Under "Configurations available in Run Dashboard" press the plus sign
• Choose "npm" from the dropdown

IDEA Checkstyle Plugin

We are using Checkstyle to ensure a high quality of code. Checkstyle is part of the build process if you have not fullfiled all requirements of checkstyle you will get errors.

To avoid building the project a lot of times to resolve Checkstyle errors you can install and use the Checkstyle-IDEA Plugin. 

Make sure to configure the right version of checkstyle in the settings of the Plugin (File/Settings/checkstyle). At the moment we are using Version 6.11.2

Updating the local working branch with upstream changes

To fetch upstream changes and rebase your locally commited changes against the upstream changes:

git pull --rebase

If you don't care about your locally commited and uncommited changes:

git fetch upstream

git reset --hard upstream/master

Contribution

You want to contribute a change? Please read the Contribution Guide first!

Documentation

1. The documentation is hosted at http://educama.org
2. If you wish to contribute you may create an account be clicking on "Sign up" on the top right hand side of the page. Preferably, select a user name like "firstname.lastname".
3. Confirm the registration mail sent to you.
4. Add a profile picture
   1. Click on the drop down on the top right
   2. Select menu entry "Profile"
   3. Select section "Picture
   4. Upload a photo
5. Optional: You may wish to register yourself as watcher to the documentation space of Educama, so that you are notified by e-mail about changes. To do that click on "Watching" on the top right hand corner and select "Watch all content in this space".

Ticketing System

1. The ticketing system is hosted at https://educama.atlassian.net/browse/ECM
2. If you wish to contribute please use the same account as documented in the section "Documentation" above.

Your First Task

You want to start hacking? Have a look at our simple and bite-sized tasks with the label "SimpleTask".