{"id":20382707,"url":"https://github.com/autodesk-forge/forge-checkmodels-createissues-revit","last_synced_at":"2025-10-25T14:11:39.642Z","repository":{"id":41378790,"uuid":"154894936","full_name":"Autodesk-Forge/forge-checkmodels-createissues-revit","owner":"Autodesk-Forge","description":"Design Check with Design Automation for Revit: Perform a basic design check on models uploaded to BIM 360 and log conflicts as Issues","archived":false,"fork":false,"pushed_at":"2023-03-03T23:31:56.000Z","size":2424,"stargazers_count":31,"open_issues_count":2,"forks_count":13,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-04-12T08:53:57.841Z","etag":null,"topics":["autodesk-bim360","autodesk-data-management","autodesk-designautomation","autodesk-revit","autodesk-webhooks","csharp","hangfire","mongodb"],"latest_commit_sha":null,"homepage":"https://revitdesigncheck.herokuapp.com","language":"C#","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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-10-26T21:11:03.000Z","updated_at":"2024-10-28T09:09:30.000Z","dependencies_parsed_at":"2025-04-12T08:53:58.735Z","dependency_job_id":"ad46cd52-9515-48e1-af0a-101e19a520eb","html_url":"https://github.com/Autodesk-Forge/forge-checkmodels-createissues-revit","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Autodesk-Forge/forge-checkmodels-createissues-revit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Autodesk-Forge%2Fforge-checkmodels-createissues-revit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Autodesk-Forge%2Fforge-checkmodels-createissues-revit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Autodesk-Forge%2Fforge-checkmodels-createissues-revit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Autodesk-Forge%2Fforge-checkmodels-createissues-revit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Autodesk-Forge","download_url":"https://codeload.github.com/Autodesk-Forge/forge-checkmodels-createissues-revit/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Autodesk-Forge%2Fforge-checkmodels-createissues-revit/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265768588,"owners_count":23825151,"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":["autodesk-bim360","autodesk-data-management","autodesk-designautomation","autodesk-revit","autodesk-webhooks","csharp","hangfire","mongodb"],"created_at":"2024-11-15T02:18:45.136Z","updated_at":"2025-10-25T14:11:34.608Z","avatar_url":"https://github.com/Autodesk-Forge.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Checks models and creates BIM 360 Issues\n\n![Platforms](https://img.shields.io/badge/Web-Windows|MacOS-lightgray.svg)\n![.NET](https://img.shields.io/badge/.NET%20Core-2.1-blue.svg)\n[![oAuth2](https://img.shields.io/badge/oAuth2-v1-green.svg)](http://developer.autodesk.com/)\n[![Data-Management](https://img.shields.io/badge/Data%20Management-v1-green.svg)](http://developer.autodesk.com/)\n[![Webhook](https://img.shields.io/badge/Webhook-v1-green.svg)](http://developer.autodesk.com/)\n[![Design-Automation](https://img.shields.io/badge/Design%20Automation-v3-green.svg)](http://developer.autodesk.com/)\n\n![Platforms](https://img.shields.io/badge/Plugins-Windows-lightgray.svg)\n![.NET](https://img.shields.io/badge/.NET%20Framework-4.7-blue.svg)\n[![Revit](https://img.shields.io/badge/Revit-2019-lightblue.svg)](http://developer.autodesk.com/)\n\n![Advanced](https://img.shields.io/badge/Level-Advanced-red.svg)\n[![License](http://img.shields.io/:license-MIT-blue.svg)](http://opensource.org/licenses/MIT)\n\n# Description\n\nThis sample monitors a BIM 360 Folder for `version.added` event, when a new RVT file (or version) is uploaded, it triggers `Design Automation` for Revit to perform a basic design check, which generates a list of `externalId` of elements that did not pass the check. This information is used to create a BIM 360 Issue, which appears on BIM 360 UI with a link to a customer Viewer to display the elements with issues.\n\nThis sample is based on [this Webhook sample](https://github.com/Autodesk-Forge/data.management-csharp-webhook). Learn more about Webhooks and 3-legged Refresh \u0026 Access Token at [this blog post](https://forge.autodesk.com/blog/webhooks-and-bim-360-c). Also based on the [Learn Forge Tutorial](http://learnforge.autodesk.io).\n\n## Thumbnail\n\n![thumbnail](thumbnail.png)\n\n## Demonstration\n\nWhatch the recording at [Youtube](https://www.youtube.com/watch?v=j9EgshGh2is).\n\n## Live version\n\nTry it at [revitdesigncheck.herokuapp.com](https://revitdesigncheck.herokuapp.com), use the [FindColumns-Basic.rvt](https://github.com/Autodesk-Forge/design.automation-csharp-revit.check.issues/raw/master/samplefile/FindColumns-Basic.rvt) sample file.\n\n# Setup\n\n## Prerequisites\n\n1. **Forge Account**: Learn how to create a Forge Account, activate subscription and create an app at [this tutorial](http://learnforge.autodesk.io/#/account/). \n2. **Visual Studio**: Either Community (Windows) or Code (Windows, MacOS).\n3. **.NET Core** basic knowledge with C#\n4. **ngrok**: Routing tool, [download here](https://ngrok.com/)\n5. **MongoDB**: noSQL database, [learn more](https://www.mongodb.com/). Or use a online version via [Mongo Altas](https://www.mongodb.com/cloud/atlas) (this is used on this sample)\n6. **AWS Account**: S3 buckets are used to store result files\n7. **Revit** 2019: required to compile changes into the plugin\n\n## Running locally\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/design.automation-csharp-revit.check.issues\n\n\n**Visual Studio** (Windows):\n\nRight-click on the project, then go to **Debug**. Adjust the settings as shown below. \n\n![](readme/visual_studio_settings.png) \n\n**Visual Studio Code** (Windows, MacOS):\n\nOpen the folder, at the bottom-right, select **Yes** and **Restore**. This restores the packages (e.g. Autodesk.Forge) and creates the launch.json file. See *Tips \u0026 Tricks* for .NET Core on MacOS.\n\n![](readme/visual_code_restore.png)\n\n**MongoDB**\n\n[MongoDB](https://www.mongodb.com) is a no-SQL database based on \"documents\", which stores JSON-like data. For testing purpouses, you can either use local or live. For cloud environment, try [MongoDB Atlas](https://www.mongodb.com/cloud/atlas) (offers a free tier). With MongoDB Atlas you can set up an account for free and create clustered instances, intructions:\n\n1. Create a account on MongoDB Atlas.\n2. Under \"Collections\", create a new database (e.g. named `designcheck`) with a collection (e.g. named `users`).\n3. Under \"Command Line Tools\", whitelist the IP address to access the database, [see this tutorial](https://docs.atlas.mongodb.com/security-whitelist/). If the sample is running on Heroku, you'll need to open to all (IP `0.0.0.0/0`). Create a new user to access the database. \n\nAt this point the connection string should be in the form of `mongodb+srv://\u003cusername\u003e:\u003cpassword\u003e@clusterX-a1b2c4.mongodb.net/designcheck?retryWrites=true`. [Learn more here](https://docs.mongodb.com/manual/reference/connection-string/)\n\nThere are several tools to view your database, [Robo 3T](https://robomongo.org/) (formerly Robomongo) is a free lightweight GUI that can be used. When it opens, follow instructions [here](https://www.datduh.com/blog/2017/7/26/how-to-connect-to-mongodb-atlas-using-robo-3t-robomongo) to connect to MongoDB Atlas.\n\n**AWS Account**\n\nCreate an AWS Account, allow API Access, the `access key` and `secret key` will be used on this sample.\n\n**ngrok**\n\nRun `ngrok http 3000 -host-header=\"localhost:3000\"` to create a tunnel to your local machine, then copy the address into the `FORGE_WEBHOOK_URL` environment variable.\n\n**Environment variables**\n\nAt the `.vscode\\launch.json`, find the env vars and add your Forge Client ID, Secret and callback URL. Also define the `ASPNETCORE_URLS` variable. The end result should be as shown below:\n\n```json\n\"env\": {\n    \"ASPNETCORE_ENVIRONMENT\": \"Development\",\n    \"ASPNETCORE_URLS\" : \"http://localhost:3000\",\n    \"FORGE_CLIENT_ID\": \"your id here\",\n    \"FORGE_CLIENT_SECRET\": \"your secret here\",\n    \"FORGE_CALLBACK_URL\": \"http://localhost:3000/api/forge/callback/oauth\",\n    \"OAUTH_DATABASE\": \"mongodb+srv://\u003cusername\u003e:\u003cpassword\u003e@clusterX-a1b2c4.mongodb.net/designcheck?retryWrites=true\",\n    \"FORGE_WEBHOOK_URL\": \"your ngrok address here: e.g. http://abcd1234.ngrok.io\",\n    \"AWS_ACCESS_KEY\": \"your AWS access key here\",\n    \"AWS_SECRET_KEY\": \"your AWS secret key here\"\n},\n```\n\n**Revit plugin**\n\nA compiled version of the `Revit` plugin (.bundles) is included on the `web` module, under `wwwroot/bundles` folder. Any changes on these plugins will require to create a new .bundle, the **Post-build** event should create it. Please [review the readme](https://github.com/Autodesk-Forge/design.automation-csharp-revit.check.issues/tree/master/revit).\n\nStart the app.\n\nOpen `http://localhost:3000` to start the app, select a folder to start monitoring. Upload a new version of the Revit file (see `/samples` folder) and the process should start.You can monitor the Jobs via Hangfire dashboard: `http://localhost:3000/hangfire`. \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\n\n# Further Reading\n\nDocumentation:\n\n- [BIM 360 API](https://developer.autodesk.com/en/docs/bim360/v1/overview/) and [App 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- [Webhook](https://forge.autodesk.com/en/docs/webhooks/v1)\n- [Design Automation](https://forge.autodesk.com/en/docs/design-automation/v3/developers_guide/overview/)\n\nDesktop APIs:\n\n- [Revit](https://knowledge.autodesk.com/support/revit-products/learn-explore/caas/simplecontent/content/my-first-revit-plug-overview.html)\n\nOther APIs:\n\n- [Hangfire](https://www.hangfire.io/) queueing library for .NET\n- [MongoDB for C#](https://docs.mongodb.com/ecosystem/drivers/csharp/) driver\n- [Mongo Altas](https://www.mongodb.com/cloud/atlas) Database-as-a-Service for MongoDB\n\n### Known Issues\n\n- **Webhook triggers twice** for new files, currently under investigation. \n\n### Tips \u0026 Tricks\n\nThis sample uses .NET Core and works fine on both Windows and MacOS, see [this tutorial for MacOS](https://github.com/augustogoncalves/dotnetcoreheroku).\n\n### Troubleshooting\n\n1. **Cannot see my BIM 360 projects**: Make sure to provision the Forge App Client ID within the BIM 360 Account, [learn more here](https://forge.autodesk.com/blog/bim-360-docs-provisioning-forge-apps). This requires the Account Admin permission.\n\n2. **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). Please see the [LICENSE](LICENSE) file for full details.\n\n## Written by\n\nAugusto Goncalves [@augustomaia](https://twitter.com/augustomaia), [Forge Partner Development](http://forge.autodesk.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fautodesk-forge%2Fforge-checkmodels-createissues-revit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fautodesk-forge%2Fforge-checkmodels-createissues-revit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fautodesk-forge%2Fforge-checkmodels-createissues-revit/lists"}