An open API service indexing awesome lists of open source software.

https://github.com/autodesk-forge/viewer-nodejs-model.as.a.service

Viewer workflow and learning guide: Enables you to upload models and test client APIs live
https://github.com/autodesk-forge/viewer-nodejs-model.as.a.service

Last synced: 14 days ago
JSON representation

Viewer workflow and learning guide: Enables you to upload models and test client APIs live

Awesome Lists containing this project

README

        

# Model as a Service Workflow Sample

[![LMV](https://img.shields.io/badge/Viewer-v1.2.23-green.svg)](http://developer-autodesk.github.io/)

## Description

### Thumbnail
![thumbnail](/thumbnail.png)

A sample demonstrating the workflow and provide a tool to learn Viewer quickly.

Live demo: [http://still-spire-1606.herokuapp.com](http://still-spire-1606.herokuapp.com/)

##Dependencies

This sample is written in Javascript, hosted on a node.js web server.

# Setup

For using this sample, you need an Autodesk developer credentials. Visit the [Forge Developer Portal](https://developer.autodesk.com), sign up for an account, then [create an app](https://developer.autodesk.com/myapps/create). For this new app, use **http://localhost:3000/api/forge/callback/oauth** as Callback URL, although is not used on 2-legged flow. Finally take note of the **Client ID** and **Client Secret**.

### Run locally

Install [NodeJS](https://nodejs.org).

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

git clone https://github.com/Developer-Autodesk/viewer-nodejs-model.as.a.service

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 FORGE_CLIENT_ID=<>
export FORGE_CLIENT_SECRET=<>
npm run dev

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

npm install
set FORGE_CLIENT_ID=<>
set FORGE_CLIENT_SECRET=<>
npm run dev

Open the browser: [http://localhost:3000](http://localhost:3000).

### Deploy on Heroku

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 the correct callback URL.

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

Watch [this video](https://www.youtube.com/watch?v=Oqa9O20Gj0c) on how deploy this sample to Heroku.

## License

That samples are licensed under the terms of the [MIT License](http://opensource.org/licenses/MIT). Please see the [LICENSE](LICENSE) file for full details.

# Tips & tricks

For local development/testing, consider use [nodemon](https://www.npmjs.com/package/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"

##Written by

Written by [Daniel Du](http://adndevblog.typepad.com/cloud_and_mobile/daniel-du.html) (Forge Partner Development)

Updated by Augusto Goncalves ([@augustomaia](https://twitter.com/augustomaia))