|
1 | 1 | # Google Drive Realtime API Playground
|
2 | 2 |
|
| 3 | + |
| 4 | + |
3 | 5 | ## Overview
|
4 | 6 |
|
5 |
| -**Google Drive Realtime API Playground**, is a web app for web developer that lets you try out the features of the [Google Drive Realtime API](https://developers.google.com/drive/realtime). |
| 7 | +**Google Drive Realtime API Playground**, is a web app that helps you to try out the features of the [Google Drive Realtime API](https://developers.google.com/drive/realtime). |
6 | 8 |
|
7 | 9 | The Playground will take you through the steps required to have the Realtime API working on your application and can be used as a reference implementation of a Google Drive Realtime API application.
|
8 | 10 |
|
9 | 11 | You can try out the Google Drive Realtime API Playground on its [live instance](https://realtimeplayground.appspot.com).
|
10 | 12 |
|
11 | 13 | ## Installation and Configuration
|
12 | 14 |
|
13 |
| -The project can be run out of any static web server though we provide a configuration file to host it on App Engine. |
| 15 | +The project can run on any static web server, but we also provide required configuration and boilerplate files to host it on App Engine. |
14 | 16 |
|
15 | 17 | If you wish to host it in your own App Engine instance make sure you set the name of your App Engine application in `/app.yaml`. To create an App Engine instance follow the instructions on [appengine.google.com](https://appengine.google.com).
|
16 | 18 |
|
17 | 19 | ### Create a Google APIs project and Activate the Drive API
|
18 | 20 |
|
19 |
| -First, you need to activate the Drive API for your app. You can do this in your app's API project in the Google APIs Console. |
| 21 | +First, you need to activate the Drive API for your app. You can do it by configuring your API project in the Google APIs Console. |
20 | 22 |
|
21 | 23 | - Create an API project in the [Google APIs Console](https://developers.google.com/console).
|
22 |
| -- Select the Services tab in your API project, and enable the Drive API and the Drive SDK. |
23 |
| -- Select the API Access tab in your API project, and click Create an OAuth 2.0 client ID. |
24 |
| -- In the Branding Information section, provide a name for your application (e.g. "Google Drive Realtime API Playground"), and click Next. Providing a product logo is optional. |
| 24 | +- Select the "Services" tab and enable the Drive API. |
| 25 | +- Select the "API Access" tab in your API project, and click "Create an OAuth 2.0 client ID". |
| 26 | +- In the Branding Information section, provide a name for your application (e.g. "CollabCube 3D"), and click Next. Providing a product logo is optional. |
25 | 27 | - In the Client ID Settings section, do the following:
|
26 | 28 | - Select Web application for the Application type
|
27 | 29 | - Click the more options link next to the heading, Your site or hostname.
|
28 | 30 | - List your hostname in the Authorized Redirect URIs and JavaScript Origins fields.
|
29 | 31 | - Click Create Client ID.
|
30 | 32 | - In the **API Access** page, locate the section **Client ID for Web applications** and note the **Client ID** value.
|
31 | 33 | - List your hostname in JavaScript origins in the Client ID settings.
|
32 |
| -- Go to the **Drive SDK** page and copy the **App ID** |
33 |
| - |
| 34 | +- Go to the **Drive SDK** page and copy the **App ID**. |
34 | 35 |
|
35 | 36 | ### Setup your App information in the code
|
36 | 37 |
|
37 | 38 | You should now have your **Client ID** and your **App ID**. In `/js/rtpg.js` change the `APP_ID` and the `CLIENT_ID` constants at the top of the file.
|
38 | 39 |
|
39 |
| -### Deploy, run that's it! |
| 40 | +### Deploy, run that's it! |
| 41 | + |
| 42 | +## Contributing |
| 43 | + |
| 44 | +Before creating a pull request, please fill out either the individual or |
| 45 | +corporate Contributor License Agreement. |
| 46 | + |
| 47 | +* If you are an individual writing original source code and you're sure you |
| 48 | +own the intellectual property, then you'll need to sign an |
| 49 | +[individual CLA](http://code.google.com/legal/individual-cla-v1.0.html). |
| 50 | +* If you work for a company that wants to allow you to contribute your work |
| 51 | +to this client library, then you'll need to sign a |
| 52 | +[corporate CLA](http://code.google.com/legal/corporate-cla-v1.0.html). |
| 53 | + |
| 54 | +Follow either of the two links above to access the appropriate CLA and |
| 55 | +instructions for how to sign and return it. Once we receive it, we'll add you |
| 56 | +to the official list of contributors and be able to accept your patches. |
0 commit comments