Classy Data

Introduction ยป Getting Started
Download and Install Classy Data Project

Java, Git and Maven

Details on project tools are given in the table opposite. If you do not intend to develop for Android, then you can ignore Gradle and Android Studio.

Classy Data is a Java project and the Java SDK version 7 or higher is required.

Classy Data is hosted on GitHub, so a Git client needs to be running in order to download and clone a local copy of the project.

Classy Data is built with Maven so it needs to be running on your PC too1. It is recommended to have the latest available version installed.

Other Tools

Classy Data development requires a Java IDE to edit the code and run the examples and unit tests. The project is created with Eclipse and is distributed with Eclipse project files. This does not exclude other IDEs such as NetBeans, JDeveloper and IntelliJ IDEA, but some adaptation may be required, depending on whether the IDE provides a facility to import Maven projects2. There are three associated projects featuring Classy Data as a dependency: Classy Apps, Classyfy and Classy Android. The third project requires Android Studio3.

The three associated projects feature Classy Data as a dependency and are built with a mix of Gradle and Maven. Note that the version of Android Plugin for Gradle used in these projects has Gradle version 2.14.1 as a minimum requirement. Maven also needs to be configured to access the Bintray repository named "JCenter".

Install Classy Data project on your PC

The Classy Data project is cloned from a Github repository. In a command console, go to your chosen workspace location and run:

git clone https://github.com/cybersearch2/classy_data.git

Upon completion, the project will be found in the "classy_data" sub directory, from now referred to as the Classy Data "home location".

The next steip is to build and deploy Java development artifacts to the local repository. These artifacts do not have any Android dependencies and are therefore generally portable. In a command console located at the Classy Data home location run:

mvn clean install -P java-build

Upon completion, the message "BUILD SUCCESS" should be displayed. If the build failed, then you will need to scroll back and investigate what error messages appeared during the build.

Java Tools

ToolDescription
gitGit is a free and open source distributed version control system.
mavenApache Maven is a software project management and comprehension tool. Recommended version 3.5.0 and above
eclipseJava developer tool, including a Java IDE, Git client and Maven integration. Recommended: Eclipse Neon 3 Packages - IDE for Java Developers or IDE for Android Developers.
gradleGradle is the primary Android build tool. Classy Data uses wrappers currently set to version 3.2.1
android studioOfficial IDE for Android application development, based on IntelliJ IDEA

Next Step - Android or Java only

You can now

You may wish to persue the first option and come back to the second after gaining some familiarity with the featured persistence package.

Notes
  1. Refer to Settings Reference for information on configuring Maven. You may be interested in details on proxies, profiles and active profiles.
  2. If your chosen IDE does not have a Maven plugin, then for each application, you can run the following command to obtain copies of dependent jars:
    mvn dependency:copy-dependencies
    The output will go to the target/dependency sub folder.
  3. Android Studio also has Gradle as a dependency. The use of wrappers allows different versions of Gradle to co-exist on one machine.