Skip to content
This repository was archived by the owner on Feb 8, 2023. It is now read-only.

Commit 6352baf

Browse files
Add docs to build the project
1 parent 0d31e8c commit 6352baf

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,24 @@
1010

1111
## Development
1212

13-
// TODO
13+
### Tools
14+
We use the following tools for development:
15+
16+
- [Maven](https://maven.apache.org/) for Java Build.
17+
- [NodeJS](http://nodejs.org/download/) required to run grunt.
18+
- [Grunt](http://gruntjs.com/getting-started) for JavaScript task management.
19+
20+
### Getting started
21+
22+
Install [NodeJS](http://nodejs.org/).
23+
Install [Maven](https://maven.apache.org/download.cgi) and add `mvn` as a global alias to run the `/bin/mvn` command inside Maven folder.
24+
25+
Browse to the project root directory and run the build:
26+
27+
$ mvn install
28+
29+
After the build completes you should be the following message in the console:
30+
31+
----------------------------------------------------------------------------
32+
BUILD SUCCESS
33+
----------------------------------------------------------------------------

0 commit comments

Comments
 (0)