{"id":20382710,"url":"https://github.com/autodesk-forge/forge-bim360reports","last_synced_at":"2025-04-12T09:02:34.291Z","repository":{"id":42360555,"uuid":"99720572","full_name":"Autodesk-Forge/forge-bim360reports","owner":"Autodesk-Forge","description":"BIM360 project dashboard example: Demonstrates how to extract properties from BIM360 elements and generate a project dashboard","archived":false,"fork":false,"pushed_at":"2022-12-08T08:27:26.000Z","size":5702,"stargazers_count":36,"open_issues_count":5,"forks_count":27,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-26T04:05:06.896Z","etag":null,"topics":["bim360","d3js","data-management","express","javascript","jquery","jstree","viewer"],"latest_commit_sha":null,"homepage":"https://bim360reports.autodesk.io/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Autodesk-Forge.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-08-08T17:46:20.000Z","updated_at":"2024-05-30T13:20:43.000Z","dependencies_parsed_at":"2023-01-25T09:16:03.901Z","dependency_job_id":null,"html_url":"https://github.com/Autodesk-Forge/forge-bim360reports","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Autodesk-Forge%2Fforge-bim360reports","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Autodesk-Forge%2Fforge-bim360reports/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Autodesk-Forge%2Fforge-bim360reports/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Autodesk-Forge%2Fforge-bim360reports/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Autodesk-Forge","download_url":"https://codeload.github.com/Autodesk-Forge/forge-bim360reports/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248543857,"owners_count":21121838,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bim360","d3js","data-management","express","javascript","jquery","jstree","viewer"],"created_at":"2024-11-15T02:18:45.212Z","updated_at":"2025-04-12T09:02:34.238Z","avatar_url":"https://github.com/Autodesk-Forge.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Visual Reports of Models\n\n![Platforms](https://img.shields.io/badge/platform-Windows|MacOS-lightgray.svg)\n[![License](http://img.shields.io/:license-MIT-blue.svg)](http://opensource.org/licenses/MIT)\n\n[![oAuth2](https://img.shields.io/badge/oAuth2-v1-green.svg)](https://forge.autodesk.com/en/docs/oauth/v2/developers_guide/overview/)\n[![Data-Management](https://img.shields.io/badge/Data%20Management-v1-green.svg)](https://forge.autodesk.com/api/data-management-cover-page/)\n[![Model-Derivative](https://img.shields.io/badge/Model%20Derivative-v2-red.svg)](https://forge.autodesk.com/api/model-derivative-cover-page/)\n[![Viewer](https://img.shields.io/badge/Viewer-v7-blue.svg)](https://forge.autodesk.com/api/viewer-cover-page/)\n\n## Thumbnail\n\n![thumbnail](/thumbnail.png)\n\n# Description\n\nThis sample application demonstrates how to extract models properties of Autodesk360/BIM360/Autodesk Construction Cloud (ACC) and generate a project dashboard. Also shows a nested view with 2d views of the model (if available). In the project tree of this sample, Autodesk360, BIM360 and ACC project are listed with different icons.\n\n   \u003cp align=\"center\"\u003e\u003cimg src=\"/project_icon.png\" width=\"200\" \u003e\u003c/p\u003e \n\nThis sample is based on the Learn [Forge tutorials](https://learnforge.autodesk.io/#/tutorials/viewhubmodels) in the section *View BIM 360 models* and *Dashboard*. The original implementation was based on [Jim Awe - LMVNavTest](https://github.com/JimAwe/LmvNavTest) (Depracated).\n\n## Live version\n\n[https://visualreports.autodesk.io](https://visualreports.autodesk.io/)\n\n\n# Setup\n\n## Prerequisites\n\n1. **BIM 360 or ACC Account**: must be Account Admin to add the app integration. [Learn about provisioning](https://forge.autodesk.com/blog/bim-360-docs-provisioning-forge-apps).\n2. **Forge Account**: Learn how to create a Forge Account, activate subscription and create an app at [this tutorial](http://learnforge.autodesk.io/#/account/). \n3. **Visual Code** or any other text-based tool.\n4. **JavaScript** basic knowledge with **jQuery**.\n5. [NodeJS](https://nodejs.org).\n\n### Run locally\n\nInstall [NodeJS](https://nodejs.org).\n\nClone 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):\n\n    git clone https://github.com/autodesk-forge/forge-visualreports\n\nTo run it, install the required packages, set the enviroment variables with your client ID \u0026 secret and finally start it. Via command line, navigate to the folder where this repository was cloned and use the following:\n\nMac OSX/Linux (Terminal)\n\n    npm install\n    export FORGE_CLIENT_ID=\u003c\u003cYOUR CLIENT ID FROM FORGE DEVELOPER PORTAL\u003e\u003e\n    export FORGE_CLIENT_SECRET=\u003c\u003cYOUR FORGE CLIENT SECRET\u003e\u003e\n    export FORGE_CALLBACK_URL=\u003c\u003cYOUR CALLBACK URL FROM FORGE DEVELOPER PORTAL\u003e\u003e\n    npm run dev\n\nWindows (use \u003cb\u003eNode.js command line\u003c/b\u003e from Start menu)\n\n    npm install\n    set FORGE_CLIENT_ID=\u003c\u003cYOUR CLIENT ID FROM FORGE DEVELOPER PORTAL\u003e\u003e\n    set FORGE_CLIENT_SECRET=\u003c\u003cYOUR FORGE CLIENT SECRET\u003e\u003e\n    set FORGE_CALLBACK_URL=\u003c\u003cYOUR CALLBACK URL FROM FORGE DEVELOPER PORTAL\u003e\u003e\n    npm run dev\n\nOpen the browser: [http://localhost:3000](http://localhost:3000).\n\n**Important:** do not use **npm start** locally, this is intended for PRODUCTION only with HTTPS (SSL) secure cookies.\n\n## Deployment\n\nTo deploy this application to Heroku, the **Callback URL** for Forge 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 for Forge.\n\n[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)\n\nWatch [this video](https://www.youtube.com/watch?v=Oqa9O20Gj0c) on how deploy samples to Heroku.\n\n\n## Packages used\n\nAll Autodesk Forge NPM packages are included by default, see complete list of what's available at [NPM website](https://www.npmjs.com/browse/keyword/autodesk). OAuth, Model Derivative and OSS are used. Some other non-Autodesk packaged are used, including [express](https://www.npmjs.com/package/express) and its session/cookie middlewares ([express-session](https://www.npmjs.com/package/express-session) and [cookie-parser](https://www.npmjs.com/package/cookie-parser)) for user session handling. The front-end uses [bootsrap](https://www.npmjs.com/package/bootstrap) and [jquery](https://www.npmjs.com/package/jquery).\n\n## Tips \u0026 tricks\n\nFor 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:\n\n    sudo npm install -g nodemon\n\nThen, instead of \u003cb\u003enpm run dev\u003c/b\u003e, use the following:\n\n    npm run nodemon\n\nWhich executes **nodemon ./start.js**.  The flag option **--ignore www/** indicates that the app should not restart if files under specific folder (such as **www**) are modified.\n\n## Further Reading\n\nDocumentation:\n\n- [BIM 360 or ACC API Provisioning](https://forge.autodesk.com/blog/bim-360-docs-provisioning-forge-apps)\n- [Data Management API](https://developer.autodesk.com/en/docs/data/v2/overview/)\n- [Viewer](https://developer.autodesk.com/en/docs/viewer/v7)\n\nTutorials:\n\n- [View BIM 360 or ACC Models](http://learnforge.autodesk.io/#/tutorials/viewhubmodels)\n\nBlogs:\n\n- [Forge Blog](https://forge.autodesk.com/categories/bim-360-api)\n- [Field of View](https://fieldofviewblog.wordpress.com/), a BIM focused blog\n- [Autodesk Construction Cloud Unified Products: Does it Affect My Application?](https://forge.autodesk.com/blog/autodesk-construction-cloud-unified-products-does-it-affect-my-application)\n- [Autodesk Build and Other Autodesk Construction Cloud Unified Products Launch](https://forge.autodesk.com/blog/autodesk-build-and-other-autodesk-construction-cloud-unified-products-launch)\n\n## Troubleshooting\n\n1. **Cannot see my BIM 360 or ACC projects**: Make sure to provision the Forge App Client ID within the BIM 360 or ACC Account, [learn more here](https://forge.autodesk.com/blog/bim-360-docs-provisioning-forge-apps). This requires the Account Admin permission.\n\n2. **Cannot load Autodesk360 model**: In Autodesk360, the model is not translated by default until the end user loads the model one time in Autodesk360, or the developer posts job to translate. \n\n3. **error setting certificate verify locations** error: may happen on Windows, use the following: `git config --global http.sslverify \"false\"`\n\n## License\n\nThis sample is licensed under the terms of the [MIT License](http://opensource.org/licenses/MIT).\nPlease see the [LICENSE](LICENSE) file for full details.\n\n## Written by\n\n\nJaime Rosales D. \u003cbr /\u003e \n[![Twitter Follow](https://img.shields.io/twitter/follow/afrojme.svg?style=social\u0026label=Follow)](https://twitter.com/AfroJme) \u003cbr /\u003eForge Partner Development \u003cbr /\u003e\n\u003ca href=\"http://developer.autodesk.com/\"\u003eForge Developer Portal\u003c/a\u003e \u003cbr /\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fautodesk-forge%2Fforge-bim360reports","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fautodesk-forge%2Fforge-bim360reports","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fautodesk-forge%2Fforge-bim360reports/lists"}