Skip to content

Commit b68d9f3

Browse files
author
Mike Davis
authored
Fix up quickstart app docs. (#325)
1 parent 91ced91 commit b68d9f3

File tree

5 files changed

+14
-273
lines changed

5 files changed

+14
-273
lines changed

java-quickstart/README.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
Optimizely Java QuickStart
22
===================
33

4-
This repository houses the Java Quickstart app that can be used to test that your java SDK can communicate with the cdn and Optimizely results. Simply create a new project with an experiment called "background_experiment" with 2 variations and a conversion event named "sample_conversion". From there you can test different attributes setups and other Optimizely Java SDK APIs. This is just a simple example that gets you up and running. Normally, the Java SDK would be running with a application server such as Dropwizard.
4+
This package contains the Java QuickStart app that can be used to test that the Java SDK can communicate with the CDN and Optimizely results.
5+
Simply create a new project with an experiment called "background_experiment" with 2 variations and a conversion event named "sample_conversion".
6+
From there you can test different attributes setups and other Optimizely Java SDK APIs.
7+
This is just a simple example that gets you up and running quickly!
58

69
## Getting Started
7-
Simply create a experiment on app.optimizely.com named "background_experiment" with variation_a and variation_b and one conversion event "simple_conversion." Use that SDK key in the Example.java and you are set to test.
10+
Create an experiment on app.optimizely.com named "background_experiment" with variations "variation_a" and "variation_b" and one conversion event "sample_conversion.".
11+
Use that SDK key in the [`com.optimizely.Example.java`](https://github.com/optimizely/java-sdk/blob/master/java-quickstart/src/main/java/com/optimizely/Example.java)
12+
and you are set to test.
813

9-
### Installing the SDK
10-
In the instance here we are using jar files copied into the libs directory for linking with the Optimizely Java SDK.
14+
### Run Example
1115

12-
#### Gradle
13-
14-
You can do a ```./gradlew``` build and run via run.sh.
16+
Running `./gradlew runExample` will build and execute [`com.optimizely.Example.java`](https://github.com/optimizely/java-sdk/blob/master/java-quickstart/src/main/java/com/optimizely/Example.java).

java-quickstart/build.gradle

+5-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
plugins {
2-
id 'java'
3-
}
4-
5-
group 'optimizely'
6-
version '1.0-SNAPSHOT'
7-
8-
sourceCompatibility = 1.8
9-
101
dependencies {
112
compile project(':core-api')
123
compile project(':core-httpclient-impl')
@@ -16,3 +7,8 @@ dependencies {
167
compile group: 'org.slf4j', name: 'slf4j-log4j12', version: '1.7.25'
178
testCompile group: 'junit', name: 'junit', version: '4.12'
189
}
10+
11+
task runExample(type: JavaExec) {
12+
main "com.optimizely.Example"
13+
classpath sourceSets.test.runtimeClasspath
14+
}

java-quickstart/gradlew

-172
This file was deleted.

java-quickstart/gradlew.bat

-84
This file was deleted.

java-quickstart/run.sh

-1
This file was deleted.

0 commit comments

Comments
 (0)