README

Altizure Earth APIs (AEA) is for developping interactive 3D earth applications.

What is this repository for?

• This is an api of altizure earth. Currently under testing.

How do I get set up?

• Dependencies

  1. nodejs
  2. yarn v0.27.5

• Setup

  1. Clone the repository

     git clone https://bitbucket.org/jingbo/altizure-earth-apis/

  2. Install npm modules

     cd altizure-earth-apis

     yarn

  3. Compile

     gulp release

  4. Edit source files, and generate Documentation (to .\docs\user_docs<en_US|zh_CN>\web\index.html)

     gulp docs-<enUS|zhCN>

Dependencies

Becasue npm>5.1.0 is not behaving expectedly (It updates package-lock.json file every time 'npm i' is performed.), we are switching to yarn.

1. install yarn globally

2. Remove package-lock.json file and node_modules folder (if there is any) under the repo directory. Note: keep the package.json file.

3. pull from git to update the yarn.lock file.

4. Run yarn. You will see node_modules generated.

   yarn

• Use yarn add (--dev) to add new modules

  yarn add [email protected]

• To update dependencies, simply run

  yarn

Setup sdk.examples

1. Fork https://bitbucket.org/jingbo/altizure.sdk.examples/

2. Git clone https://bitbucket.org/<YOUR_NAME>/altizure.sdk.examples/ to the same directory of this repo.

+-- parent
|   +-- altizure-earth-apis
|   +-- altizure.sdk.examples

3. Under this repo,

cd altizure-earth-apis

create a symbolic link named sdk.examples pointing to ../altizure.sdk.examples. e.g. for linux,

ln -s ../altizure.sdk.examples/ sdk.examples

4. Edit files in ./src or ./sdk.examples. Then use gulp build to copy the compiled altizure.js file to ./sdk.examples/build/.

5. Setup server under ./sdk.examples. Then you can check results through browswer http://127.0.0.1:8000/examples.sdk.debug.html

python -m SimpleHTTPServer 8000

6. To commit changes on sdk.examples, create a pull request to https://bitbucket.org/jingbo/altizure.sdk.examples/.

7. More information please refer to https://bitbucket.org/jingbo/altizure.sdk.examples/overview

Visualize Code Structure

yarn struct

Translate en_US docs to zh_CN

1. Make sure you have the key for google translation at /docs/COMP4901J-eff6a4fb6651.json

2. Setup sdk.examples (see instruction above)

3. Fork https://bitbucket.org/fengyee/translate_docs/

4. Git clone https://bitbucket.org/<YOUR_NAME>/translate_docs/ to the same directory of this repo.

+-- parent
|   +-- altizure-earth-apis
|   +-- altizure.sdk.examples
|   +-- translate_docs

5. Execute the bash script under the parent node

cd translate_docs && yarn && cd ../altizure-earth-apis

6. Execute the bash script under the repo altizure-earth-apis

export GOOGLE_APPLICATION_CREDENTIALS=$(pwd)'/docs/COMP4901J-eff6a4fb6651.json'
yarn setup-translator && yarn translate

Who do I talk to?

• Altizure team
• Dr. Jingbo Liu