Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/autodesk-forge/forge-sketchit-revit
SketchIt is web application that creates walls and floors in a SVG Canvas to later create & visualize the result RVT file.
https://github.com/autodesk-forge/forge-sketchit-revit
Last synced: about 5 hours ago
JSON representation
SketchIt is web application that creates walls and floors in a SVG Canvas to later create & visualize the result RVT file.
- Host: GitHub
- URL: https://github.com/autodesk-forge/forge-sketchit-revit
- Owner: Autodesk-Forge
- Created: 2019-02-19T12:17:14.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-11T10:55:20.000Z (11 months ago)
- Last Synced: 2024-04-09T21:50:09.678Z (7 months ago)
- Language: JavaScript
- Homepage: https://sketchitapp.herokuapp.com
- Size: 24 MB
- Stars: 31
- Watchers: 7
- Forks: 15
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sketch on the browser and generate Revit models
[](https://nodejs.org/)
[](https://www.npmjs.com/)
[](http://forge.autodesk.com/)
[](http://forge.autodesk.com/)
[](http://autodesk.com/revit)
[](http://opensource.org/licenses/MIT)
# Description
This 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.
The sketcher is built using Redux with React and makes use of Flux architecture extensively.
# How does it work?
# Main Parts of The Work
1. Create a Revit Plugin to be used within AppBundle of Design Automation for Revit. Please check [PlugIn](./SketchIt/Revit.Addin/README.md)
2. Create your App, upload the AppBundle, define your Activity and test the workitem with [Insomnia Rest](./SketchIt/Insomnia.REST/README.md) workflow.
3. Create the Web App to call the workitem.
# Web App Setup
## Prerequisites
For 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**.
1. **Forge Account**: Learn how to create a Forge Account, activate subscription and create an app at [this tutorial](http://learnforge.autodesk.io/#/account/).
2. **Visual Code**: Visual Code (Windows or MacOS).
3. **ngrok**: Routing tool, [download here](https://ngrok.com/)
4. **Revit 2019**: required to compile changes into the plugin
5. **JavaScript ES6** syntax for server-side.
6. **JavaScript** basic knowledge with **jQuery**
7. **React & Redux & Flux** framework architecture
## Running locally
Install [NodeJS](https://nodejs.org), version 8 or newer.
Clone 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):
git clone https://github.com/autodesk-forge/design.automation-nodejs-sketchIt.git
To 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:
Mac OSX/Linux (Terminal)
npm install
export FORGE_CLIENT_ID=<>
export FORGE_CLIENT_SECRET=<>
export FORGE_BUCKET_KEY=<>
export FORGE_ACTIVITY_ID=<>
export FORGE_WEBHOOK_URL=<>
npm start
Windows (use **Node.js command line** from Start menu)
npm install
set FORGE_CLIENT_ID=<>
set FORGE_CLIENT_SECRET=<>
set FORGE_BUCKET_KEY=<>
set FORGE_ACTIVITY_ID=<>
set FORGE_WEBHOOK_URL=<>
npm start
### Start the app
Open 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.
## Further Reading
Documentation:
- [Design Automation API](https://forge.autodesk.com/en/docs/design-automation/v3/developers_guide/overview/)
- [Data Management API](https://developer.autodesk.com/en/docs/data/v2/overview/)
Desktop APIs:
- [Revit](https://knowledge.autodesk.com/support/revit-products/learn-explore/caas/simplecontent/content/my-first-revit-plug-overview.html)
## License
This sample is licensed under the terms of the [MIT License](http://opensource.org/licenses/MIT). Please see the [LICENSE](LICENSE) file for full details.
## Written by
Jaime Rosales D. [](https://twitter.com/AfroJme)
[Forge Partner Development](http://forge.autodesk.com)