petrbroz / fdx-graph-explorer

Simple explorer of Forge Data Exchange graphs.

fdx-graph-explorer

Simple explorer of Autodesk Forge Exchanges and their graphs.

Development

Prerequisites

• Autodesk Forge app credentials (see the Create an App tutorial)
• Access to an Autodesk Construction Cloud project (currently the Data Exchanges are only supported in this product)
• Node.js (we recommend the LTS version), and yarn
• Terminal (for example, Windows Command Prompt, or macOS Terminal)

Setup & Run

• Clone this repository
• Install dependencies: yarn install
• Setup env. variables:
  • FORGE_CLIENT_ID - your Forge application client ID
  • FORGE_CLIENT_SECRET - your Forge application client secret
  • FORGE_CALLBACK_URL - callback URL for the login workflow
    • When running locally, this should be http://localhost:8080/api/auth/callback
    • Also, make sure that you setup the exact same callback URL for your Forge app in https://forge.autodesk.com/myapps
  • SERVER_SESSION_SECRET - arbitrary string that will be used to encipher/decipher session cookies
  • USE_CACHE (optional) - when set to a non-empty string, the app will cache all Data Exchange responses, and respond with the cached data next time it is requested
• Run the app: npm start

If you're using Visual Studio Code, consider creating a .vscode/launch.json with the following content (replacing the placeholders with your actual env. var. values):

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "pwa-node",
            "request": "launch",
            "name": "Launch Program",
            "skipFiles": [
                "<node_internals>/**"
            ],
            "program": "${workspaceFolder}/server.js",
            "env": {
                "FORGE_CLIENT_ID": "your-client-id",
                "FORGE_CLIENT_SECRET": "your-client-secret",
                "FORGE_CALLBACK_URL": "http://localhost:8080/api/auth/callback",
                "SERVER_SESSION_SECRET": "your-secret-phrase",
                "USE_CACHE": "true"
            }
        }
    ]
}

Then you can easily run and debug the application right from the editor.