Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/autodesk-forge/viewer-walkthrough-online.viewer

Online Viewer Walkthrough: Build a viewer that converts and displays models on a browser
https://github.com/autodesk-forge/viewer-walkthrough-online.viewer

Last synced: 3 months ago
JSON representation

Online Viewer Walkthrough: Build a viewer that converts and displays models on a browser

Host: GitHub
URL: https://github.com/autodesk-forge/viewer-walkthrough-online.viewer
Owner: Autodesk-Forge
License: mit
Created: 2018-11-01T03:08:29.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2023-03-06T11:40:48.000Z (almost 2 years ago)
Last Synced: 2024-04-09T21:50:14.573Z (11 months ago)
Language: JavaScript
Size: 1.07 MB
Stars: 60
Watchers: 5
Forks: 70
Open Issues: 7
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Online Viewer sample

[![Node.js](https://img.shields.io/badge/Node.js-8.11.1-blue.svg)](https://nodejs.org/)

[![npm](https://img.shields.io/badge/npm-6.1.0-blue.svg)](https://www.npmjs.com/)

![Platforms](https://img.shields.io/badge/platform-windows%20%7C%20osx%20%7C%20linux-lightgray.svg)

[![License](http://img.shields.io/:license-mit-blue.svg)](http://opensource.org/licenses/MIT)

[![oAuth2](https://img.shields.io/badge/oAuth2-v1-green.svg)](https://forge.autodesk.com/)

[![Data-Management](https://img.shields.io/badge/Data%20Management-v2-green.svg)](https://forge.autodesk.com/)

[![Model-Derivative](https://img.shields.io/badge/Model%20Derivative-v2-green.svg)](https://forge.autodesk.com/)

[![Viewer](https://img.shields.io/badge/Viewer-v7-green.svg)](https://forge.autodesk.com/)

# Description

This sample is part of the [Online Viewer Walkthrough](https://forge.autodesk.com/developer/learn/viewer-app).

In this sample, we will be creating a simple web page that allows end users to upload some files to Forge storage service, then translate them and display them in a web browser.

- Authenticate your developer identity

- Create a bucket

- Get bucket detail

- Save a supported file to a bucket

- Read the uploaded file from a bucket

- Translate the file to the SVF format

- Display the file in a web browser

## Thumbnail

![thumbnail](/thumbnail.png)

# Setup

## Prerequisites

1. A Forge account: [Getting Started with Forge](https://forge.autodesk.com/developer/getting-started)

2. A text editor of your choice. (For example Brackets or Visual Studio Code are good choices.)

3. A basic knowledge of :

    - HTML and CSS

    - JavaScript ES6

    - Command-line programs

      - Node.js Command Line (for Windows users)

      - Terminal (for Mac/Linux/Unix users)

## Running locally

Install [NodeJS](https://nodejs.org/) (version 8 or newer).

Clone this project or download it. It's recommended to install [GitHub desktop](https://desktop.github.com/).

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)

```bash

npm install

export FORGE_CLIENT_ID=<>

export FORGE_CLIENT_SECRET=<>

npm start

```

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

```bash

npm install

set FORGE_CLIENT_ID=<>

set FORGE_CLIENT_SECRET=<>

npm start

```

Open a browser and navigate to http://localhost:3000.

Click on the `Authorize me` link and then click through the links on the browser to:

  - Create a bucket

  - Save a supported file to a bucket

  - Display the file in a web browser

*NOTE:* _It may take several minutes to complete translate the file._

# License

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

# Support

[email protected]