{"id":15366360,"url":"https://github.com/petrbroz/bim360-issue-editor","last_synced_at":"2025-04-15T12:21:07.010Z","repository":{"id":35931114,"uuid":"219696801","full_name":"petrbroz/bim360-issue-editor","owner":"petrbroz","description":"Prototype application for bulk-editing BIM 360 issues using Autodesk Forge APIs.","archived":false,"fork":false,"pushed_at":"2023-02-07T10:23:29.000Z","size":1087,"stargazers_count":9,"open_issues_count":11,"forks_count":11,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-03-28T20:05:58.141Z","etag":null,"topics":["autodesk-forge","bim360","bootstrap","jquery"],"latest_commit_sha":null,"homepage":"https://bim360-issue-editor.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/petrbroz.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":"2019-11-05T08:40:39.000Z","updated_at":"2023-12-18T11:22:52.000Z","dependencies_parsed_at":"2023-01-16T09:30:33.799Z","dependency_job_id":null,"html_url":"https://github.com/petrbroz/bim360-issue-editor","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/petrbroz%2Fbim360-issue-editor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/petrbroz%2Fbim360-issue-editor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/petrbroz%2Fbim360-issue-editor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/petrbroz%2Fbim360-issue-editor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/petrbroz","download_url":"https://codeload.github.com/petrbroz/bim360-issue-editor/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249067953,"owners_count":21207415,"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-forge","bim360","bootstrap","jquery"],"created_at":"2024-10-01T13:18:35.432Z","updated_at":"2025-04-15T12:21:06.983Z","avatar_url":"https://github.com/petrbroz.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# bim360-issue-editor\n\n![Platforms](https://img.shields.io/badge/platform-Windows|MacOS-lightgray.svg)\n![Node.js](https://img.shields.io/badge/node-%3E%3D%2010.0.0-brightgreen.svg)\n![License](https://img.shields.io/badge/license-MIT-green.svg)\n\n[![Data-Management](https://img.shields.io/badge/Data%20Management-v1-green.svg)](https://forge.autodesk.com/en/docs/data/v2/reference)\n[![BIM360](https://img.shields.io/badge/BIM360-v1-green.svg)](https://forge.autodesk.com/en/docs/bim360/v1/reference)\n\n![Intermediate](https://img.shields.io/badge/Level-Intermediate-blue.svg)\n\nPrototype application for bulk-editing [BIM 360](https://www.autodesk.com/bim-360/) issues\nusing [Autodesk Forge](https://forge.autodesk.com) APIs.\n\n![Screenshot](./docs/screenshot.png)\n\n## Running\n\n### Web Application\n\nLive demo is running on https://bim360-issue-editor.autodesk.io.\n\nIn order to be able to access your BIM 360 project from this demo, you will need to add\nthe following Forge credentials as a [custom integration](https://forge.autodesk.com/en/docs/bim360/v1/tutorials/getting-started/manage-access-to-docs):\n\n- Forge Client ID: `YhryNMLor4R1maFhY4zER8unpISoP5E4`\n- Forge App Name: `Internal BIM360 Testing App`\n\n### Command-Line Utility\n\nThe project includes two command-line scripts (under the _bin/_ folder) that can be used\nto export issues to XLSX and import them back, locally. The scripts require a configuration\nfile that is generated by the web application.\n\n\u003e Since the configuration contains sensitive data such as authentication tokens,\n\u003e it is provided in a password-protected ZIP archive. The password is configured\n\u003e using the `CLI_CONFIG_PASSWORD` environment variable.\n\n1. Navigate to the issue page for one of your BIM360 projects\n2. Use the \"Command-Line Config\" button in the bottom toolbar\n3. Download the archive and extract the configuration JSON\n4. Open your command-line (make sure that you have [Node.js](https://nodejs.org/en) installed), and navigate to this project's root folder\n5. Try one of the following commands:\n  - To export BIM360 issues to XLSX: `node bin/bim360-to-excel.js \u003cpath/to/unzipped/config.json\u003e \u003cpath/to/output/spreadsheet.xlsx\u003e`\n  - To import issues from XLSX back to BIM360: `node bin/excel-to-bim360.js \u003cpath/to/unzipped/config.json\u003e \u003cpath/to/input/spreadsheet.xlsx\u003e`\n    - Optionally, include the `--sequential` parameter to update issues in sequence instead of in parallel\n    - Optionally, include a `--range=\u003cstarting_row_number\u003e-\u003cending_row_number\u003e` parameter to only update issues in a given range of spreadsheet rows\n  \u003e The scripts assume that the path to the spreadsheet is valid, so make sure that the entire folders structure is available\n\n## Development\n\n### Prerequisites\n\n- [Node.js](https://nodejs.org) v10.15 or newer, and [yarn](https://yarnpkg.com)\n- Forge application credentials ([creating an app](https://forge.autodesk.com/en/docs/oauth/v2/tutorials/create-app/))\n  - Callback URL of the Forge application must be set to your host followed by `/auth/callback` so, for example, when running the application locally, the URL should be `http://localhost:3000/auth/callback`\n- BIM 360 project with the Forge application added as a [custom integration](https://forge.autodesk.com/en/docs/bim360/v1/tutorials/getting-started/manage-access-to-docs)\n\n### Setup\n\n- clone this repository\n- install dependencies: `yarn install`\n- (for now) manually build the _forge-server-utils_ dependency: `cd node_modules/forge-server-utils \u0026\u0026 yarn run build:node`\n- provide the following env. variables\n  - `FORGE_CLIENT_ID` - client ID of your Forge application\n  - `FORGE_CLIENT_SECRET` - client secret of your Forge application\n  - `FORGE_APP_NAME` - name of your Forge application (used when asking user to setup the BIM 360 integration)\n  - `HOST_URL` - URL where the demo application is running (for example, _http://localhost:3000_)\n  - `SERVER_SESSION_SECRET` - secret phrase used to encrypt session cookies\n  - `CLI_CONFIG_PASSWORD` - password to be used to encrypt the command-line configuration file\n\n#### On macOS\n\n```bash\nexport FORGE_CLIENT_ID=\u003cclient id\u003e\nexport FORGE_CLIENT_SECRET=\u003cclient secret\u003e\nexport FORGE_APP_NAME=\u003capp name\u003e\nexport HOST_URL=\u003chost url\u003e\nexport SERVER_SESSION_SECRET=\u003csecret phrase\u003e\nexport CLI_CONFIG_PASSWORD=\u003canother secret phrase\u003e\nyarn start\n```\n\n#### On Windows\n\n```\nset FORGE_CLIENT_ID=\u003cclient id\u003e\nset FORGE_CLIENT_SECRET=\u003cclient secret\u003e\nset FORGE_APP_NAME=\u003capp name\u003e\nset HOST_URL=\u003chost url\u003e\nset SERVER_SESSION_SECRET=\u003csecret phrase\u003e\nset CLI_CONFIG_PASSWORD=\u003canother secret phrase\u003e\nyarn start\n```\n\n#### Using VSCode\n\nWhen using [Visual Studio Code](https://code.visualstudio.com), add this configuration to your _.vscode/launch.json_:\n\n```json\n{\n    \"type\": \"node\",\n    \"request\": \"launch\",\n    \"name\": \"Launch Server\",\n    \"program\": \"${workspaceFolder}/server.js\",\n    \"env\": {\n        \"FORGE_CLIENT_ID\": \"\u003cclient id\u003e\",\n        \"FORGE_CLIENT_SECRET\": \"\u003cclient secret\u003e\",\n        \"FORGE_APP_NAME\": \"\u003capp name\u003e\",\n        \"HOST_URL\": \"\u003chost url\u003e\",\n        \"SERVER_SESSION_SECRET\": \"\u003csecret phrase\u003e\",\n        \"CLI_CONFIG_PASSWORD\": \"\u003canother secret phrase\u003e\"\n    }\n}\n```\n\n## License\n\nThis sample is licensed under the terms of the [MIT License](https://tldrlegal.com/license/mit-license).\nRefer to [LICENSE](LICENSE) for more details.\n\n## Author\n\nPetr Broz ([@ipetrbroz](https://twitter.com/ipetrbroz)), Forge Partner Development Group\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpetrbroz%2Fbim360-issue-editor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpetrbroz%2Fbim360-issue-editor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpetrbroz%2Fbim360-issue-editor/lists"}