Skip to end of metadata
Go to start of metadata

Install software

Required

  • Git
  • Java 11
    • Set environment variable JAVA_HOME=<path to java jdk directory>
    • Add %JAVA_HOME%\bin to your PATH environment variable
  • Eclipse IDE 2019‑06. Download and run the installer and choose "Eclipse IDE for Enterprise Java Developers."
  • From the Eclipse Marketplace, install the following:
    • Spring Tools 4, should include the following:
      • EGit
      • Buildship Gradle Integration 3.0
    • Groovy Development Tools 3.5. 0. SNAPSHOT
    • SonarLint
  • MariaDB
    • Install with default character encoding UTF8
    • Add the bin directory of MariaDB to the PATH environment variable
    • Set the following environment variables:
      • YONA_DB_URL=jdbc:mariadb://localhost:3306/yona
      • YONA_DB_USER_NAME=<user name of your choice, e.g. root)
      • YONA_DB_PASSWORD=<password of the above user>

Optional

Set up Eclipse

Add Java code style

In order to use a consistent code style throughout the sources of Yona you should import the attached code style in your Eclipse. To do this:

  • Download the file YonaCodestyle.xml
  • Import it into Eclipse by going to Preferences -> Java -> Code Style -> Formatter:
  • From your source files you can press Ctrl-Shift-F to format the code

To enable code formatting, go to Preferences -> Java -> Editor -> Save Actions and click the Configure Workspace Settings link:

        

Select the "Perform the selected actions on save" and "Format source code' and 'Organize imports" check boxes and Additional actions as shown in the screen shot.

Configure Groovy code style

The code formatter for Groovy is quite limited. Configure it this way:

And configure the save actions:

Configure SonarLint

Right-click a Yona project to configure Sonar:


  • Choose SonarQube
  • Enter the URL: https://sonar.dev.yona.nu/
  • Choose the token authentication method, log on to the server, generate a token and paste it in Eclipse
  • Name the connection Yona
  • Bind all Yona projects to this connection
  • Select the SonarQube project YonaServer

Set up environment

  • Clone the repository

    git clone https://github.com/yonadev/yona-server.git
  • Create eclipse projects:

    gradlew eclipse
  • Import the projects into your workspace in Eclipse:
    • File --> Import
    • Existing projects into workspace
    • Select the yona-server folder
    • Check the box "Search for nested projects"
    • Do not check the box "Copy projects into workspace"
    • Click finish
  • Mark the sources with tests (all projects: src/test/java , core: src/testUtils/groovy , other projects: src/intTest/groovy ) as test sources. See Eclipse documentation for how to do this.
  • Set the following environment variables:
    • YONA_DB_PASSWORD=<your MariaDB password> 
    • YONA_DB_URL=jdbc:mariadb://localhost:3306/yona 
    • YONA_DB_USER_NAME=<your MariaDB user> 
  • Add the scripts directory to PATH
  • No labels