GETTING STARTED

How to start using the VLINGO/PLATFORM.

The VLINGO/PLATFORM is distributed as a set of libraries and is documentation is available online. The following sections explain how to access both.

To get started quickly with your first example, see the Hello, World! project.

Using Artifacts

The artifacts for the Java Development Kit are available as jar files from three primary public repositories, Bintray, Sonatype, and Maven Central.

Our platform CI builds are performed on Travis-CI, which pushes the successfully built artifacts to Bintray. When we create a release we replicate the Bintray artifacts to Sonatype, which in turn automatically replicates to Maven Central.

We also support daily SNAPSHOT builds on JFrog/Bintray. If you want to use the latest code you may reference it as artifactId-x.y.x-SNAPSHOT. See below for more details.

You may use any number of build tools to retrieve the JAR files that you need for a project. We generally recommend using either Maven or Gradle. You can include the following in your Maven pom.xml file to reference the vlingo/actors toolkit:

...
<repositories>
<repository>
<id>central</id>
<url>http://repo1.maven.org/maven2/</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>io.vlingo</groupId>
<artifactId>vlingo-actors</artifactId>
<version>x.y.z</version>
<scope>compile</scope>
</dependency>
</dependencies>
...

You may reference SNAPSHOT builds, by including the snapshot repository, as follows.

...
<repositories>
<repository>
# also include normal repository here
</repository>
<repository>
<id>oss-jfrog-snapshot</id>
<url>https://oss.jfrog.org/artifactory/oss-snapshot-local</url>
<releases>
<enabled>false</enabled>
</releases>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>io.vlingo</groupId>
<artifactId>vlingo-actors</artifactId>
<version>1.3.1-SNAPSHOT</version>
<scope>compile</scope>
</dependency>
</dependencies>
...

For use with Gradle you will need something like the following. Refer to the above Maven pom.xml for the location of our snapshots.

dependencies {
compile 'io.vlingo:vlingo-actors:x.y.z'
}
repositories {
jcenter()
// or
mavenCentral()
}

Of course the x.y.z is representative placeholder of the semantic version number of the given artifact. You should examine Bintray for the most recent available daily build artifacts, which are considered snapshots. Stable releases are provided on Sonatype and Maven Central. Generally the tip revision of each JAR file listed in the repository is the one that will work together with all others as a whole platform.

Full open source for the Java platform is available on https://github.com/vlingo. Our baseline JDK is 1.8, but we have successfully used on JDK 1.14. On GitHub you see each of the components that are available, and the above dependency information applies to each of the platform components, but you must supply the actual component name. We maintain version numbers consistent across the entire platform, meaning that if version 1.3.2 applies to vlingo-actors then it also applies to vlingo-lattice and the remaining platform components. The following is an example that uses platform version 1.3.1, but the version should be adjusted to your specific dependencies.

...
<dependencies>
<dependency>
<groupId>io.vlingo</groupId>
<artifactId>vlingo-actors</artifactId>
<version>1.3.1</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>io.vlingo</groupId>
<artifactId>vlingo-http</artifactId>
<version>1.3.1</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>io.vlingo</groupId>
<artifactId>vlingo-symbio</artifactId>
<version>1.3.1</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>io.vlingo</groupId>
<artifactId>vlingo-lattice</artifactId>
<version>1.3.1</version>
<scope>compile</scope>
</dependency>
</dependencies>
...

Documentation and Examples

Since you are reading this, you have already found our primary platform documentation.

Our Javadoc is available via javadoc.io, and is relative to the current release. The URL pattern is as follows:

http://javadoc.io/doc/io.vlingo/vlingo-actors/1.0.0

This pattern repeats for all artifacts available on Maven Central for specific versions. The README.md for each open source artifact references the current API-based Javadoc. For example, see the vlingo-actors README.md.

Examples are available in source form under the https://github.com/vlingo/vlingo-examples URL. There are currently 10 projects, and within these you will find highlights of platform usage.

Support is currently available on https://gitter.im/vlingo-platform-java/community. Other channels will be available in time.

You may register for access to our public Stack workspace for both Java and .NET.

Follow us on Twitter @vlingo_io.