Developer Quick Start

Requirements

• Ubuntu 16.04 or 18.04
• Latest update of Java JDK 8. In the future Java 11 will be supported.
• Apache Maven 3

Recommended folder structure and projects:

• Clone Ant-Media-Server, Ant-Media-ServerCommon, ant-media-server-parent, Ant-Media-Server-Service, ManagementConsole_WebApp, red5-plugins, StreamApp projects from GitHub into $home_directory_path/AntMedia where $home_directory_path is path of your home directory.
• If you are a Enterprise developer: clone the Ant-Media-Enterprise from Gitlab into $home_directory_path/AntMedia.
• Create folder $home_directory_path/softwares/ant-media-server for the deployed Ant Media Server. Some deployment scripts like redeploy.sh will copy the compiled Ant Media Server into this directory. ``

Recommended IDEs for Development

• Latest version of Eclipse IDE for Java EE Developers
• It is also possible to use other Java compatible IDEs like IntelliJ or NetBeans but core development team currently uses Eclipse for Java EE.

Eclipse Plugins

• SonarLint : for static code analysis
• EclEmma : for test coverage

Eclipse and Maven setup

• Change the default Maven used in Eclipse by giving path of the Maven home directory (/usr/share/$maven_version for default installation) in the Preferences/Maven/Installations section of Eclipse.
• Import the projects to the Eclipse using import existing Maven projects wizard.

Deployment

• redeploy.sh scripts in in Ant-Media-Server or Ant-Media-Enterprise can be used to build and deploy Ant Media Server into $home_directory_path/softwares/ant-media-server

Debugging the Server

• Start the server in debug mode using start-debug.sh script in $home_directory_path/softwares/ant-media-server which is generated after deployment.
• Create a Remote Java Application Debug Configuration in Eclipse in Debug Configurations settings (Project: ant-media-server Host: localhost Port: 8787)
• Add all the AntMedia Server projects in Eclipse to the Source Lookup Path in the Source Tab of the Debug Configuration.