Checking out the code
Info |
---|
Requirements: git |
...
, GitHub Account |
Create a remote fork of https://github.com/Taskana/taskana
Info title Fork A Repo (Github Help) Configure git to automatically adjust line endings with each commit
(optional, but recommended)
Code Block language bash git config --global core.autocrlf input
Create a local clone
Code Block language bash # using https git clone https://github.com/<yourname>/taskana.git # using ssh git clone git@github.com:<yourname>/taskana.git
Confiure Configure git to automatically validate your commit messages (more information: Contribution Guide)
Code Block language bash cd taskana git config core.hooksPath qa/hooks
Optional: Create a symlink to
.git/hooks
in order to support external toolsCode Block rm -rf .git/hooks ln -s $PWD/qa/hooks .git/hooks
Create a remote for the upstream project so that it is later easier to retrieve changes from the main repository.
Code Block language bash # 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)
Info |
---|
Requirements: java, mavennode, nodeyarn |
Info |
---|
Version requirements: Java 11, Node 12Node 16.1914.02 |
Info |
---|
We use maven wrapper. For windows please use |
Full build
Code Block | ||
---|---|---|
| ||
./mvnw clean install |
...
Code Block | ||
---|---|---|
| ||
./mvnw clean install -f lib |
Rest Api
Code Block | |
---|---|
bash | |
./mvnw clean install -f rest |
UI (admin / monitor / workspace)
Code Block | ||
---|---|---|
| ||
cd web npm installyarn |
Warning |
---|
When a taskana version is changed please do not forget to build taskana-parent, taskana-rest-parent and taskana-lib-parent B) See codeblock below |
Code Block |
---|
./mvnw clean install -N && ./mvnw clean install -N -f lib && ./mvnw clean install -N -f restpl :taskana-parent,:taskana-common-parent,:taskana-rest-parent,:taskana-history-parent or ./mvnw install -pl :<module name> -am |
...
Start the application(s)
Info |
---|
Requirements: java maven, node |
Rest Api
First of all change devMode property to true in taskanaand enableCsrf property to false in taskana-rest-spring-example-boot application.properties file, then follow the next steps.
...
Admin, Monitor and Workplace UI
Info | ||
---|---|---|
Make sure to run the following command in /web/ before starting the application:
|
Code Block | ||
---|---|---|
| ||
cd web ngyarn servestart |
Then you can open a browser pointing to http://localhost:4200/ url to access to web application.
...