https://github.com/yiskang/aps-viewer-area-plans-demo

This Autodesk Platform Services viewer sample demonstrates how to use Edit2D extension to manage area plans
https://github.com/yiskang/aps-viewer-area-plans-demo

autodesk-platform-services autodesk-viewer extensions sample

Last synced: 21 days ago
JSON representation

This Autodesk Platform Services viewer sample demonstrates how to use Edit2D extension to manage area plans

• Host: GitHub
• URL: https://github.com/yiskang/aps-viewer-area-plans-demo
• Owner: yiskang
• License: mit
• Created: 2023-08-31T15:17:53.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-21T00:47:35.000Z (over 1 year ago)
• Last Synced: 2024-10-31T02:52:09.310Z (2 months ago)
• Topics: autodesk-platform-services, autodesk-viewer, extensions, sample
• Language: JavaScript
• Homepage: https://aps-area-plans.autodesk.io
• Size: 4.28 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Simple Viewer Area Plan (Node.js)

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

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

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

[![license](https://img.shields.io/:license-mit-green.svg)](https://opensource.org/licenses/MIT)

This [Autodesk Platform Services](https://aps.autodesk.com) viewer sample demonstrates how to use [Edit2D](https://aps.autodesk.com/en/docs/viewer/v7/developers_guide/advanced_options/edit2d-setup/) extension to manage area plans.

![thumbnail](thumbnail.gif)

## Development

### Prerequisites

- [APS credentials](https://forge.autodesk.com/en/docs/oauth/v2/tutorials/create-app)

- [Node.js](https://nodejs.org) (we recommend the Long Term Support version)

- Terminal (for example, [Windows Command Prompt](https://en.wikipedia.org/wiki/Cmd.exe)

or [macOS Terminal](https://support.apple.com/guide/terminal/welcome/mac))

### Technology Architecture Diagram

![architecture](technology-architecture.jpeg)

### Setup & Run

- Clone this repository

- Install dependencies: `yarn install` or `npm install`

- Setup environment variables:

  - `APS_CLIENT_ID` - your APS application client ID

  - `APS_CLIENT_SECRET` - your APS application client secret

  - `APS_BUCKET` (optional) - name of APS bucket to store your designs in

- Run the server: `yarn install` or `npm start`

> When using [Visual Studio Code](https://code.visualstudio.com),

you can specify the env. variables listed above in a _.env_ file in this

folder, and run & debug the application directly from the editor.

## Troubleshooting

Please contact us via https://forge.autodesk.com/en/support/get-help.

## License

This sample is licensed under the terms of the [MIT License](http://opensource.org/licenses/MIT).

Please see the [LICENSE](LICENSE) file for more details.