Before getting into how to develop on your machine, there are a few dependencies that need to be installed:
Apache Maven 3.5.3+
NodeJS 8.12+ (only for web development)
Yarn package manager 1.10+ (only for web development)
For working with BigConnect's code base, and IDE is highly recommended. We perform a lot of our development using the IntelliJ IDEA IDE, but other editors like Eclipse can be used as well.
Since all repositories are Maven projects, importing the project in your IDE should be straightforward. Just open the repository folder and the IDE should handle the rest.
Install JDK 1.8 and Apache Maven. Optionally, make sure that the
mvncommand is added to your path.
Install NodeJS and the Yarn package manager (optional)
Install and run ElasticSearch using its default configuration
Install Grunt globally:
npm install -g grunt-cli (optional)
Clone a GitHub repository
To run the web console from your IDE, you need to open the bigconnect-web project and create a Run configuration.
A Run configuration for IntelliJ IDEA is detailed in bigconnect-web's repository README.md file.