{"id":20382684,"url":"https://github.com/autodesk-forge/forge-sketchit-revit","last_synced_at":"2025-04-12T08:54:10.667Z","repository":{"id":40950782,"uuid":"171468331","full_name":"Autodesk-Forge/forge-sketchit-revit","owner":"Autodesk-Forge","description":"SketchIt is web application that creates walls and floors in a SVG Canvas to later create \u0026 visualize the result RVT file. ","archived":false,"fork":false,"pushed_at":"2023-12-11T10:55:20.000Z","size":25137,"stargazers_count":34,"open_issues_count":17,"forks_count":15,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-12T08:54:05.859Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://sketchitapp.herokuapp.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"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":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-02-19T12:17:14.000Z","updated_at":"2024-12-25T19:19:55.000Z","dependencies_parsed_at":"2023-01-25T22:16:37.631Z","dependency_job_id":null,"html_url":"https://github.com/Autodesk-Forge/forge-sketchit-revit","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-sketchit-revit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Autodesk-Forge%2Fforge-sketchit-revit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Autodesk-Forge%2Fforge-sketchit-revit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Autodesk-Forge%2Fforge-sketchit-revit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Autodesk-Forge","download_url":"https://codeload.github.com/Autodesk-Forge/forge-sketchit-revit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248543883,"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":[],"created_at":"2024-11-15T02:18:37.284Z","updated_at":"2025-04-12T08:54:10.649Z","avatar_url":"https://github.com/Autodesk-Forge.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sketch on the browser and generate Revit models\n\n[![Node.js](https://img.shields.io/badge/Node.js-8.0-blue.svg)](https://nodejs.org/)\n[![npm](https://img.shields.io/badge/npm-4.0-blue.svg)](https://www.npmjs.com/)\n![Platforms](https://img.shields.io/badge/Web-Windows%20%7C%20MacOS%20%7C%20Linux-lightgray.svg)\n[![Design-Automation](https://img.shields.io/badge/Design%20Automation-v3-green.svg)](http://forge.autodesk.com/)\n\n[![Viewer](https://img.shields.io/badge/Viewer-v6.5-green.svg)](http://forge.autodesk.com/)\n\n\n![Windows](https://img.shields.io/badge/Plugins-Windows-lightgrey.svg)\n![.NET](https://img.shields.io/badge/.NET%20Framework-4.7-blue.svg)\n[![Revit-2019](https://img.shields.io/badge/Revit-2019-lightgrey.svg)](http://autodesk.com/revit)\n\n\n![Advanced](https://img.shields.io/badge/Level-Advanced-red.svg)\n[![MIT](https://img.shields.io/badge/License-MIT-blue.svg)](http://opensource.org/licenses/MIT)\n\n# Description\n\nThis NodeJS app demonstrates an end to end use case for external developers using Design Automation for Revit. In addition to using Design Automation for Revit REST APIs, this app also leverages other Autodesk Forge services like Data Management API (OSS), Viewer API and Model Derivative services.\n\nThe sketcher is built using Redux with React and makes use of Flux architecture extensively.\n\n# How does it work?\n![thumbnail](thumbnail.gif) \n\n# Main Parts of The Work\n1. Create a Revit Plugin to be used within AppBundle of Design Automation for Revit. Please check [PlugIn](./SketchIt/Revit.Addin/README.md) \n2. Create your App, upload the AppBundle, define your Activity and test the workitem with [Insomnia Rest](./SketchIt/Insomnia.REST/README.md)  workflow.\n\n3. Create the Web App to call the workitem.\n\n# Web App Setup\n\n## Prerequisites\n\nFor using this sample, you need an Autodesk developer credentials. Visit the [Forge Developer Portal](https://developer.autodesk.com), sign up for an account, then [create an app](https://developer.autodesk.com/myapps/create). For this new app, use `http://localhost:3000/api/forge/callback/oauth` as Callback URL, although is not used on 2-legged flow. Finally take note of the **Client ID** and **Client Secret**.\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 Code**: Visual Code (Windows or MacOS).\n3. **ngrok**: Routing tool, [download here](https://ngrok.com/)\n4. **Revit 2019**: required to compile changes into the plugin\n5. **JavaScript ES6** syntax for server-side.\n6. **JavaScript** basic knowledge with **jQuery**\n7. **React \u0026 Redux \u0026 Flux** framework architecture \n\n## Running locally\n\nInstall [NodeJS](https://nodejs.org), version 8 or newer.\n\nClone this project or download it (this `nodejs` branch only). 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-nodejs-sketchIt.git\n\nTo run it, install the required packages, set the enviroment variables with your Client ID, Secret, Bucket Key and Nickname value 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 DEVELOPER PORTAL\u003e\u003e\n    export FORGE_CLIENT_SECRET=\u003c\u003cYOUR CLIENT SECRET\u003e\u003e\n    export FORGE_BUCKET_KEY=\u003c\u003cYOUR UNIQUE BUCKET KEY\u003e\u003e\n    export FORGE_ACTIVITY_ID=\u003c\u003cYOUR DESIGN AUTOMATION ACTIVITY ID\u003e\u003e\n    export FORGE_WEBHOOK_URL=\u003c\u003cYOUR DESIGN AUTOMATION FOR REVIT CALLBACK URL\u003e\u003e\n    npm start\n\nWindows (use **Node.js command line** from Start menu)\n\n    npm install\n    set FORGE_CLIENT_ID=\u003c\u003cYOUR CLIENT ID FROM DEVELOPER PORTAL\u003e\u003e\n    set FORGE_CLIENT_SECRET=\u003c\u003cYOUR CLIENT SECRET\u003e\u003e\n    set FORGE_BUCKET_KEY=\u003c\u003cYOUR UNIQUE BUCKET KEY\u003e\u003e\n    set FORGE_ACTIVITY_ID=\u003c\u003cYOUR DESIGN AUTOMATION ACTIVITY ID\u003e\u003e\n    set FORGE_WEBHOOK_URL=\u003c\u003cYOUR DESIGN AUTOMATION FOR REVIT CALLBACK URL\u003e\u003e\n    npm start\n\n\n### Start the app\n\nOpen the browser: [http://localhost:3000](http://localhost:3000). Select the element to create (top-right buttons). Click on `Generate Revit Model`, wait until is ready to view.\n\n\n## Further Reading\n\nDocumentation:\n\n- [Design Automation API](https://forge.autodesk.com/en/docs/design-automation/v3/developers_guide/overview/)\n- [Data Management API](https://developer.autodesk.com/en/docs/data/v2/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\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\n\nJaime Rosales D. [![Twitter Follow](https://img.shields.io/twitter/follow/afrojme.svg?style=social\u0026label=Follow)](https://twitter.com/AfroJme) \n\n[Forge Partner Development](http://forge.autodesk.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fautodesk-forge%2Fforge-sketchit-revit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fautodesk-forge%2Fforge-sketchit-revit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fautodesk-forge%2Fforge-sketchit-revit/lists"}