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 https://github.com/MyCollab/mycollab/issues or contact us via MyCollab contact form https://www.mycollab.com/contact/

Clone the latest MyCollab sources from Github

You can use your favorite Git client or git command line to clone MyCollab repository https://github.com/MyCollab/mycollab.git

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

Download the latest IntelliJ version at https://www.jetbrains.com/idea/download/. 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 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

Install IntelliJ Scala plugin

MyCollab uses Scala the second programming language besides Java, and we will migrate some Java codes to Scala in the upcoming MyCollab versions. Without the Scala plugin, the IntelliJ will say there are some classes could not be found.

Go to Settings > Plugins and search Scala, then install the Scala plugin. Restart the IntelliJ to make the change is affected.

Scala Plugin

 

Go to File > Project Structure, and choose the Scala SDK used in MyCollab project and modules. We are using the Scala SDK 2.11.7, and you should choose this version as well.

Scala SDK

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

Run MyCollab

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

  • VM Settings: -server -Xms128m -Xmx768m -XX:MaxPermSize=256m -XX:+DisableExplicitGC -XX:+CMSClassUnloadingEnabled -XX:+UseConcMarkSweepGC
  • Program arguments: –port 8080 (you can replace 8080 by any port you want MyCollab web run with)
  • Working directory: the module MyCollab program is running. You should choose the variable name $MODULE_DIR
  • Use classpath of module: Select the project ‘mycollab-app-community’

MyCollab Runner

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

Was this article helpful to you? Yes 7 No 1

How can we help?