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
- nodejs
- yarn v0.27.5
-
Setup
-
Clone the repository
git clone https://bitbucket.org/jingbo/altizure-earth-apis/
-
Install npm modules
cd altizure-earth-apis
yarn
-
Compile
gulp release
-
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
.
-
Remove
package-lock.json
file andnode_modules
folder (if there is any) under the repo directory. Note: keep thepackage.json
file. -
pull from git to update the
yarn.lock
file. -
Run yarn. You will see
node_modules
generated.yarn
-
Use
yarn add (--dev)
to add new modulesyarn add package-name@1.2.3 -
To update dependencies, simply run
yarn
Setup sdk.examples
-
Fork
https://bitbucket.org/jingbo/altizure.sdk.examples/
-
Git clone
https://bitbucket.org/<YOUR_NAME>/altizure.sdk.examples/
to the same directory of this repo.
+-- parent
| +-- altizure-earth-apis
| +-- altizure.sdk.examples
- 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
-
Edit files in
./src
or./sdk.examples
. Then usegulp build
to copy the compiledaltizure.js
file to./sdk.examples/build/
. -
Setup server under
./sdk.examples
. Then you can check results through browswerhttp://127.0.0.1:8000/examples.sdk.debug.html
python -m SimpleHTTPServer 8000
-
To commit changes on
sdk.examples
, create a pull request tohttps://bitbucket.org/jingbo/altizure.sdk.examples/
. -
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
-
Make sure you have the key for google translation at
/docs/COMP4901J-eff6a4fb6651.json
-
Setup sdk.examples (see instruction above)
-
Fork
https://bitbucket.org/fengyee/translate_docs/
-
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
- Execute the bash script under the parent node
cd translate_docs && yarn && cd ../altizure-earth-apis
- Execute the bash script under the repo altizure-earth-apis
export GOOGLE_APPLICATION_CREDENTIALS=$(pwd)'/docs/COMP4901J-eff6a4fb6651.json'yarn setup-translator && yarn translate