http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/ec2b3e4f/website/publish/docs/messagee-example/index.html ---------------------------------------------------------------------- diff --git a/website/publish/docs/messagee-example/index.html b/website/publish/docs/messagee-example/index.html deleted file mode 100644 index d5c92c9..0000000 --- a/website/publish/docs/messagee-example/index.html +++ /dev/null @@ -1,421 +0,0 @@ - - - - - - Apache Usergrid (incubating) — Messagee Example - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- - -
-
- - -

Messagee Example

-

Messagee is a simple Twitter-style messaging application that leverages the extensive functionality of App services. This section describes some of the features of Messagee.

-

There are three client versions of Messagee:

- -

The sections below describe how to create a new app, enter some test users, and run the app. You also learn how to use the App services admin portal, a user interface that streamlines data and application management in the App services system. The portal is also a reference application that shows how to incorporate App services APIs with JavaScript. For a more detailed discussion of the portal’s functionality, see Admin portal.

-

Creating a user account in App services

-

Go to https://apigee.com/usergrid/ to access the login screen for the App services admin portal. If you are new to App services, sign up for an account to access the portal, specifying an organization (e.g., the name of your company or project team) and a username and password that you can use to authenticate. Because App services are designed for use by development teams, the same username can be associated with one or more organizations.

-

If you create a new account, you receive a confirmation email that contains a URL that you must click to activate the account. After this, simply log in to the portal with your username and password.

-
- -
-

Creating an app and users

-

When you have logged in, you need to create a new application.

-
- -
-
    -
  1. -
      -
    1. Enter a unique application name. The name must be unique to avoid a conflict with another user running the same application.
    2. -
    -
    - -
    -
  2. -
  3. -
      -
    1. Make sure that the portal shows the application name you entered as the active application beneath the Applications menu (1).
    2. -
    -

    If the correct name is not displayed, click the menu and select your application.

    -

    Next, you need to populate a test user user-test-1 that is going to log in to your copy of the server-side Messagee app.

    -
  4. -
  5. -
      -
    1. Click the Users box on the left side of the console (2).
    2. -
    -
    - -
    -
  6. -
  7. -
      -
    1. Click the Add button and enter the user information for your application in the pop-up window (be sure to create a password you can remember), and then click the Create button. Repeat these steps to create a second username test-user-2.
    2. -
    -
    - -
    -
  8. -
  9. -
-

When you have finished all these steps, you have a new application and two new users.

-
- -
-

Now that you have created a uniquely named copy of the Messagee application as well as two user accounts (test-user-1 and test-user-2), you are ready to test out the Messagee app. Use test-user-1 to log in to the app, and test-user-2 as the user to follow.

-

To continue with the example, follow the instructions for a client app (iOS client, Android client, or HTML5 client).

-

iOS client

-

Messagee is available as an iPhone app that uses Apache Usergrid and RestKit. The source for the iOS version of Messagee is available in the /samples/messagee directory of the Apache Usergrid iOS SDK

-

Here are the steps to run the Messagee app on iOS:

-
    -
  1. -
      -
    1. Run Steps 1-6 under Creating an app and users.
    2. -
    -

    These steps create a unique instance of the Messagee app on the server and two test users, test-user-1 and test-user-2.

    -
  2. -
  3. -
      -
    1. Access the Messagee server app by typing a URL similar to the following into your iOS mobile client (replace <Messagee> with the unique name of your application):
    2. -
    -

    https://api.usergrid.com/<Messagee>/index.html

    -
    - -
    -
  4. -
  5. -
      -
    1. On the mobile client, complete the registration information and click Register.
    2. -
    -
    - -
    -
  6. -
  7. -
      -
    1. Log in to the Messagee app by entering the test-user-1 account information created previously, and click the Sign in button.
    2. -
    -
    - -
    -

    At this point, the message board is empty:

    -
    - -
    -
  8. -
  9. -
      -
    1. To post a message using the app, click the top-right icon in the message board to create a message, write the message text, and send it by clicking Post.
    2. -
    -
    - -
    -

    Note: The posted message should appear in the message board within few seconds.

    -
    - -
    -

    For your instance of the Messagee application to act like Twitter, you need to “follow” another user.

    -
  10. -
  11. -
      -
    1. In the message board, click Add People and add test-user-2 as a person that test-user-1 follows.
    2. -
    -
    - -
    -
  12. -
    1. -
    2. Log in as test-user-2 and post a message as this user to the message board.
    3. -
  13. -
  14. -
      -
    1. Go back and log in as user test-user-1.
    2. -
    -

    Because test-user-1 follows test-user-2, you should see the message sent by test-user-2 in the message board.

    -
    - -
    -
  15. -
  16. -
-

iOS SDK

-

If you want to write iOS applications that connect to App services, download the Apache Usergrid iOS SDK

-

Note: The Messagee iOS application uses RestKit, a popular REST framework for iOS, to communicate with App services. Because App services use a REST API, you can use any REST framework to talk with the service. However, the official App services iOS SDK provides a more convenient communication mechanism that you should use unless you’re already using RestKit or some other framework in your project.

-

Android client and SDK

-

Messagee is available as a sample Android app that acts as a App services client. The source for the Android version is packaged with the Apache Usergrid Android SDK in the /samples/messagee directory.

-

Download the Apache Usergrid Android SDK.

-

Javascript/HTML5 client and SDK

-

Messagee is also available as a sample HTML5 app that behaves in much the same way as the two previous examples. The source for the HTML5 version is packaged with the Apache Usergrid Javascript/HTML5 SDK in the /samples/messagee directory.

-

Download the Apache Usergrid Javascript/HTML5 SDK.

-
-
-
-
-
-
-
- Questions? Please do ask on the mailing-lists!
- -
-
-
-
- - - - - - - - - - - - http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/ec2b3e4f/website/publish/docs/nodejs-module/index.html ---------------------------------------------------------------------- diff --git a/website/publish/docs/nodejs-module/index.html b/website/publish/docs/nodejs-module/index.html deleted file mode 100644 index 4ba0951..0000000 --- a/website/publish/docs/nodejs-module/index.html +++ /dev/null @@ -1,307 +0,0 @@ - - - - - - Apache Usergrid (incubating) — Node.js module - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- - -
-
- - -

Installation

-

From the command-line, run:

-
$ npm install usergrid
-

Client Initialization

-

TODO

-

Organizations

-
// Create an Organization
-var options = {
-    method:'POST',
-    endpoint:'management/orgs',
-    body:{ 
-          password:'test12345', 
-          email:'tester12345@gmail.com', 
-          name:'test', 
-          username:'tes123', 
-          organization:'testorg' 
-    }    
-};
-client.request(options, function (err, data) {
-    if (err) {
-        //error — POST failed
-    } else {
-        //success — data will contain raw results from API call        
-    }
-});
-
-
-// Read an Organization
-var options = {
-    method:'GET',
-    endpoint:'management/orgs/testorg'
-};
-client.request(options, function (err, data) {
-    if (err) {
-        //error — GET failed
-    } else {
-        //success — data will contain raw results from API call        
-    }
-});
-
-
-
-
-
-
-
- Questions? Please do ask on the mailing-lists!
- -
-
-
-
- - - - - - - - - - - - http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/ec2b3e4f/website/publish/docs/old-forks/index.html ---------------------------------------------------------------------- diff --git a/website/publish/docs/old-forks/index.html b/website/publish/docs/old-forks/index.html deleted file mode 100644 index dd12500..0000000 --- a/website/publish/docs/old-forks/index.html +++ /dev/null @@ -1,285 +0,0 @@ - - - - - - Apache Usergrid (incubating) — What about old forks of Apigee Usergrid? - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- - -
-
- - -

If you previously developed with Apigee Usergrid (i.e. before we moved to Apache), you know our code used to be structured into separate repositories: usergrid-stack, usergrid-portal, etc. We are now using a merged repository.

-

How to update your code setup & pull changes from your old forks

-

You just need to clone this repository, and use git subtree (usually requires git 1.8+) to merge your changes under the new structure. Here’s an example for a portal fork. Adjust the prefix, repository address and branch you want to pull from as necessary.

-
git clone git@github.com:apache/incubator-usergrid.git
-cd usergrid
-git subtree pull --prefix=portal git@github.com:my-github-account/my-usergrid-portal-fork.git master
-

This will pull (i.e. merge) the changes you made from the master branch of github.com/my-github-account/my-usergrid-portal-fork into the portal/ subfolder. It should ask you to provide a commit message for the merge. There’s lot of flexibility on how to fetch and merge, please see the git subtree manual for details. Then please do consider sending us a pull request with these changes ;)

-

How to pull commits made on this repo into your old forks

-

You should really update your old repositories to the new structure with the instructions above, but the following may work for you, although we make no guarantee they will work in the future.

-

You can produce a branch compatible with the old repos by using git subtree (usually requires git 1.8+). Then from this repository you can

-
git clone git@github.com:apache/incubator-usergrid.git
-cd usergrid
-git checkout master
-git subtree split --prefix=portal -b portal
-git checkout portal
-

This will create a “portal” branch that is compatible with the old usergrid-portal repository, from the code under the portal/ directory. You can pull from that branch (or push changes to it, although we will not accept pull requests sent thusly).

-

The git subtree split above should function for portal, ugc, and any of the SDKs, but will not work for the stack, due to some anonymous comments left in the tree that prevent a split, and cannot be corrected lest we break the history and force a rebase on all forks.

-

Please update your code setup as soon as possible and ask the dev list if you have any questions!

-
-
-
-
-
-
-
- Questions? Please do ask on the mailing-lists!
- -
-
-
-
- - - - - - - - - - - -