Skip to content

Commit c56e15e

Browse files
author
AUSTIN A. HAMILTON
committed
Fix README
1 parent 76fffac commit c56e15e

2 files changed

Lines changed: 20 additions & 37 deletions

File tree

README.md

Lines changed: 12 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Unless required by applicable law or agreed to in writing, software distributed
1919

2020
#### • Download IBM Bluemix Plug-in ####
2121

22-
You will also need to download the Cloud Foundry plug-in for Eclipse. To do this, go to Eclipse and follow the instructions below:
22+
You will also need to download the IBM Bluemix plug-in for Eclipse. To do this, go to Eclipse and follow the instructions below:
2323

2424
1. Click: Help > Eclipse Marketplace...
2525
2. Search: "Bluemix"
@@ -32,9 +32,7 @@ You will also need to download the Cloud Foundry plug-in for Eclipse. To do thi
3232

3333
Next, you will need to import the project into [**Eclipse**](https://www.eclipse.org/downloads/packages/eclipse-ide-java-ee-developers/keplersr2). Recommendation is to use the Eclipse IDE for Java EE Developers.
3434

35-
There are two ways you can get the source into Eclipse:
36-
37-
Option A. Import the WAR File (Preferred)
35+
#### Import the WAR File ####
3836
1. Navigate to https://github.com/ibmjstart/bluemix-java-sample-twitter-influence-app/releases
3937
2. Click the green button labeled "twitter_influence_analyzer-1.2.war" and that will download the WAR file.
4038
3. Open Eclipse
@@ -43,32 +41,21 @@ Option A. Import the WAR File (Preferred)
4341
6. Select the war file from where it was downloaded. Ensure that `Target Runtime` is targeting IBM Bluemix.
4442
7. Click `Next` and then `Finish` and the project should be imported into Eclipse
4543

46-
-OR-
47-
48-
Option B. Import the Eclipse project by following these instructions: (Only if you want to modify the source code.)
49-
50-
1. Open Eclipse
51-
2. Select File->Import
52-
3. Under the header labeled "Git", click "Projects from Git" and click `Next`
53-
4. Select `Clone URI` and click `Next`
54-
5. Copy paste the clone URL into the next page. Hit `Next`
55-
56-
![image](images/clone_url.png)
57-
6. Select the Branch to clone (you should only need Master). Click `Next`
58-
7. Name the destination directory. click `Next`
59-
8. Check `Import Existing Projects` and click `Next`
60-
9. Check the project, and click `Finish`
61-
6244
### Step 3. Acquiring External and Public APIs ###
6345

6446
**Your app will not work if you do not add your Twitter API keys and access Tokens to your environment variable.**
6547

66-
This app uses some external APIs. You need to register the app with Twitter and Klout to get the keys and tokens.
48+
This app uses some external APIs. You need to register the app with Twitter to get the keys and tokens.
6749

6850
#### • Twitter v1.1 API ####
6951

7052
To access the Twitter API you need the consumer keys and access tokens, so you must register the app with Twitter. You can register your app [here](https://dev.twitter.com/).
7153

54+
When you set up your twitter application settings, it will ask for the fully-qualified URL to your website. This should match, exactly, the URL you plan to use for your bluemix app.
55+
For example, if your Bluemix app will be located at `http://jstart-tia.mybluemix.net`, then the `Website` text box under Create an Application should read that exact URL. You will have to match this
56+
to the subdomain that you give when your app is deployed.
57+
58+
7259
[More information on how to register the app with Twitter](registerTwitter.md)
7360

7461
#### • Google Maps v3 API ####
@@ -97,7 +84,8 @@ Make sure you are in the Java EE [perspective](http://help.eclipse.org/juno/inde
9784
4. Click: `Finish`
9885
5. Enter a Name for your app and select: `Next`
9986
6. Enter THE SAME subdomain that you used to register with Twitter. (e.g. `https://`**`myTwitterApp`**`.mybluemix.net`) Click `Next`
100-
7. (Optional) Bind the Cloudant NoSQLDB service. If it is not already created, select the icon in the top right. (Refer to Option B of Creating a Cloudant Service for how to search and create the service.) Hit `Next`
87+
7. Create and bind the Cloudant NoSQLDB service. If it is not already created, select the icon in the top right. (Refer to Option B of [Creating a Cloudant Service](#cloudant) for how to search and create the service.)
88+
The application is built to assume that you leave the default name of "cloudantNoSQLDB" for your service name. If you change the name, the app may break. Hit `Next`
10189
8. **IMPORTANT:** Add your Twitter API credentials under environment variables. Right click, and select `Add`. Provide this information:
10290

10391

@@ -110,12 +98,12 @@ Make sure you are in the Java EE [perspective](http://help.eclipse.org/juno/inde
11098

11199
![image](images/environment_variables.png)
112100

113-
You may do this step later, but your application will fail without it. Click: `Finish`. Your app will deploy to Bluemix. If you haven't already created and bound your cloudant service, please refer to Step 5: Create a Cloudant Service
101+
9. You may do this step later, but your application will fail without it. Click: `Finish`. Your app will deploy to Bluemix. If you haven't already created and bound your cloudant service, please refer to Step 5: Create a Cloudant Service
114102

115103
**CONGRATS!** Your app is now published to Bluemix.
116104
(Note: It can take a few minutes to upload everything and deploy all of the services.)
117105

118-
### Step 5. Create a Cloudant service ###
106+
### <a name="cloudant"></a> Step 5. Create a Cloudant service ###
119107

120108
There are two ways to create and bind the cloudant service to your application.
121109

app/pom.xml

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@
66
<packaging>war</packaging>
77
<build>
88
<sourceDirectory>src</sourceDirectory>
9+
<resources>
10+
<resource>
11+
<directory>${build.sourceDirectory}</directory>
12+
<includes>
13+
<include>**/*.java</include>
14+
</includes>
15+
</resource>
16+
</resources>
917
<plugins>
1018
<plugin>
1119
<artifactId>maven-war-plugin</artifactId>
@@ -15,18 +23,6 @@
1523
<failOnMissingWebXml>false</failOnMissingWebXml>
1624
</configuration>
1725
</plugin>
18-
<plugin>
19-
<groupId>org.apache.maven.plugins</groupId>
20-
<artifactId>maven-war-plugin</artifactId>
21-
<configuration>
22-
<webResources>
23-
<resource>
24-
<directory>${build.sourceDirectory}</directory>
25-
<targetPath>WEB-INF/src</targetPath>
26-
</resource>
27-
</webResources>
28-
</configuration>
29-
</plugin>
3026
<plugin>
3127
<artifactId>maven-compiler-plugin</artifactId>
3228
<version>3.1</version>
@@ -48,7 +44,6 @@
4844
<groupId>org.ektorp</groupId>
4945
<artifactId>org.ektorp</artifactId>
5046
<version>1.4.1</version>
51-
<scope>provided</scope>
5247
</dependency>
5348
<dependency>
5449
<groupId>com.fasterxml.jackson.core</groupId>

0 commit comments

Comments
 (0)