Check out and build

Checking out the code

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

2. Create a remote fork of https://github.com/Taskana/taskana

   Fork A Repo (Github Help)

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

3. Configure git to automatically adjust line endings with each commit (optional, but recommended)

   git config --global core.autocrlf input

4. Create a local clone

   # using https
   git clone https://github.com/<yourname>/taskana.git
   # using ssh
   git clone git@github.com:<yourname>/taskana.git

5. Confiure git to automatically validate your commit messages (more information: Contribution Guide)

   cd taskana
   git config core.hooksPath qa/hooks

   1. Optional: Create a symlink to .git/hooks in order to support external tools

      rm -rf .git/hooks
      ln -s $PWD/qa/hooks .git/hooks

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

   # using https
   git remote add upstream https://github.com/Taskana/taskana.git
   # using ssh
   git remote add upstream git@github.com:Taskana/taskana.git

Build the application(s)

Full build

./mvnw clean install

Taskana Library

mvn clean install -f lib

Rest Api

mvn clean install -f rest

UI (admin / monitor / workspace)

cd web
npm install

mvn clean install -N && mvn clean install -N -f lib && mvn clean install -N -f rest
or
mvn install -pl :<module name> -am

Start the application(s)

Rest Api

First of all change devMode property to true in taskana-rest-spring-example-boot application.properties file, then follow the next steps.

./mvnw spring-boot:run -pl :taskana-rest-spring-example-boot 

Admin, Monitor and Workplace UI

cd web
ng serve

Then you can open a browser pointing to http://localhost:4200/ url to access to web application.

Architecture example after running previous steps.