This guide is intended for those who wish to:
Contribute code to BigConnect
Create their own BigConnect plugins
Create a custom build of BigConnect
In order to work with BigConnect as a developer, it's recommended that you are proficient with the following technologies:
Java, since the entire back end is written in Java
If that sounds like you, then please keep in mind the following conventions you'll encounter while reading this guide.
Any reference to
$BIGCONNECT_DIR refers to the base directory for BigConnect configuration. The most important subdirectory to this is the
config directory, where BigConnect configuration properties files placed.
While we do recommend reading all the pages in this Developer Guide, the steps below are the fastest path to getting an instance of BigConnect up and running in no time.
You need to have Java 1.8 and Apache Maven 3.5.3+ installed.
The platform consists of several projects:
First, clone the source code for all three GitHub repositories:
git clone https://github.com/mware-solutions/bigconnect.gitgit clone https://github.com/mware-solutions/dw-plugins.gitgit clone https://github.com/mware-solutions/bigconnect-web.git
Second, build the bigconnect and dw-plugns projects. Go into each folder and do:
mvn -DskipTests install
Third, change to the bigconnect-web folder and run the web application:
mvn -Pbuild-webapp,dev-tomcat-run install
This will start the embedded Tomcat server with an embedded ElasticSearch node and H2 database.
Once started, the web console will be available at http://localhost:8888