Setup MyCollab projects with IntelliJ IDE - Free and open source project management software

  1. Home
  2. Developing MyCollab
  3. Setup MyCollab projects with IntelliJ IDE

Setup MyCollab projects with IntelliJ IDE

We recommend IntelliJ, a powerful IDE for Java and Scala language. All MyCollab developers use IntelliJ as our development tool until we have any further change. If you have any issues to set up MyCollab with IntelliJ and need help, you can ask the question to Github issue or contact us via MyCollab contact form

Clone the latest MyCollab sources from Github

You can use your favorite Git client or git command line to clone MyCollab repository

Download the IntelliJ IDE if you don’t have it yet

Download the latest IntelliJ version at The community version is enough for developing the MyCollab application.

Import the Maven project to IntelliJ

Select File > New > Project from existing sources … then choose the folder you check out the latest version of MyCollab from Github

Import MyCollab Projects

Then choose the import project from Maven external model. You must select the options ‘Search for projects recursively’ and ‘Import Maven projects automatically’. All of the other settings are the defaults of IntelliJ

Configure Maven Settings

IntelliJ will create an empty project names ‘mycollab-deployer-community’. Select File > New > Module from existing sources … And you select the folder you check out MyCollab from Github again. IntelliJ will import all MyCollab modules to the project as the following screenshot

MyCollab Project Folders

Build MyCollab project

Then make by selecting Build > Make Project the whole MyCollab modules. The compile process should work without any issue.

Install MySQL Server and create MyCollab schema

You must install MySQL Server 5.5+ and create an empty MyCollab schema before running MyCollab. See the detail at Creating the MyCollab schema

Compile the Vaadin widgetset

MyCollab uses Vaadin as its UI layer, and you need to compile the Vaadin widget set before running MyCollab. If you already have installed MyCollab submodules in Maven, the you only need to run maven command in the project ‘mycollab-app-community’

mvn install

Otherwise, you can always install all MyCollab sub modules and Vaadin widgetsets by running maven command ‘mvn install’ under project ‘mycollab-deployer-community’

Run MyCollab

If you pass all the above steps successfully, then this task is straightforward by creating a Java application with main class com.mycollab.server.DefaultServerRunner in the module mycollab-server-runner with following settings:

  • Use classpath of the module: Select the project ‘mycollab-app-community’
  • Working directory: choose the value mycollab-app-community/src/main

You can see our settings to run the MyCollab as in the screenshot. At the first time of running MyCollab, it will open the browser ask you to configure the system settings. See the link helps you set up the site correctly at Install MyCollab

Creating the MyCollab distribution

We build the MyCollab binaries in every release, and if you modify MyCollab for your organization, you can create the custom MyCollab by yourself. Check how to do at Create MyCollab installer by yourself

Still having a problem?

You can post any question to the MyCollab forum

How can we help?