autodesk-platform-services / aps-hubs-tools

Hubs Tools:Utility application for Data Management and Model Derivative API

Hubs Tools

Description

This sample shows how you can use the Model Derivative API and what you can do with it and also uses Autodesk Viewer for showing models. The front-end will look like:

Thumbnail

Live version

See it live at https://derivatives.autodesk.io

Setup

Prerequisites

1. BIM 360 or other Autodesk storage account: if you want to use it with files from BIM 360 Docs then you must be an Account Admin to add the app integration. Learn about provisioning.
2. APS Account: Learn how to create a APS Account, activate subscription and create an app at this tutorial.
3. Visual Studio Code: other text editors could be used too, but Visual Studio Code is a widely used editor, see https://code.visualstudio.com/
4. Node.js: basic knowledge of Node.js, see https://nodejs.org/en/
5. JavaScript: basic knowledge

Running locally

Install NodeJS.

Clone this project or download it. It's recommended to install GitHub desktop. To clone it via command line, use the following (Terminal on MacOSX/Linux, Git Shell on Windows):

git clone https://github.com/autodesk-platform-services/aps-hubs-tools

To run it, install the required packages, set the enviroment variables with your client ID & secret and finally start it. Via command line, navigate to the folder where this repository was cloned and use the following:

Mac OSX/Linux (Terminal)

npm install
export APS_CLIENT_ID=<<YOUR CLIENT ID FROM DEVELOPER PORTAL>>
export APS_CLIENT_SECRET=<<YOUR CLIENT SECRET>>
npm run dev

Windows (use Node.js command line from Start menu)

npm install
set APS_CLIENT_ID=<<YOUR CLIENT ID FROM DEVELOPER PORTAL>>
set APS_CLIENT_SECRET=<<YOUR CLIENT SECRET>>
npm run dev

Open the browser: http://localhost:3000.

Important: do not use npm start locally, this is intended for PRODUCTION only with HTTPS (SSL) secure cookies.

Deployment

To deploy this application to Heroku, the Callback URL must use your .herokuapp.com address. After clicking on the button below, at the Heroku Create New App page, set your Client ID, Secret and Callback URL.

Watch this video on how deploy samples to Heroku.

Further reading

Documentation:

• BIM 360 API and App Provisioning
• Data Management API
• Viewer

Tutorials:

• View BIM 360/ACC Models
• Retrieve Issues

Blogs:

• APS Blog
• Field of View, a BIM focused blog

Tips & tricks

For local development/testing, consider use nodemon package, which auto restart your node application after any modification on your code. To install it, use:

sudo npm install -g nodemon

Then, instead of npm run dev, use the following:

npm run nodemon

Which executes nodemon server.js --ignore www/, where the --ignore parameter indicates that the app should not restart if files under www folder are modified.

Troubleshooting

After installing Github desktop for Windows, on the Git Shell, if you see a error setting certificate verify locations error, use the following:

git config --global http.sslverify "false"

License

This sample is licensed under the terms of the MIT License. Please see the LICENSE file for full details.

Written by

Adam Nagy (Autodesk Partner Development)
http://aps.autodesk.com