{"id":21488811,"url":"https://github.com/boblyx/speckle-hackathon","last_synced_at":"2025-10-19T09:02:00.856Z","repository":{"id":243496339,"uuid":"811469370","full_name":"boblyx/speckle-hackathon","owner":"boblyx","description":"Web based BI tool and Revit plugin for coordinated BIM family management","archived":false,"fork":false,"pushed_at":"2024-06-13T01:33:31.000Z","size":276,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-01-23T20:17:09.137Z","etag":null,"topics":["auditing","bim","business-intelligence","revit","speckle"],"latest_commit_sha":null,"homepage":"https://devpost.com/software/dataxonomy?ref_content=user-portfolio\u0026ref_feature=in_progress","language":"JavaScript","has_issues":false,"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/boblyx.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-06T16:51:05.000Z","updated_at":"2024-08-11T20:41:44.000Z","dependencies_parsed_at":"2024-06-13T06:10:20.913Z","dependency_job_id":null,"html_url":"https://github.com/boblyx/speckle-hackathon","commit_stats":null,"previous_names":["boblyx/speckle-hackathon"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boblyx%2Fspeckle-hackathon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boblyx%2Fspeckle-hackathon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boblyx%2Fspeckle-hackathon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boblyx%2Fspeckle-hackathon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/boblyx","download_url":"https://codeload.github.com/boblyx/speckle-hackathon/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244019996,"owners_count":20384860,"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":["auditing","bim","business-intelligence","revit","speckle"],"created_at":"2024-11-23T14:11:52.377Z","updated_at":"2025-10-19T09:01:55.807Z","avatar_url":"https://github.com/boblyx.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FamilyMan \r\nSubmitted for the 2024 Beyond the Speckleverse Hackathon.\r\n\r\nThe project aims to enhance project management with a system that:\r\n- Handles atomic BIM family updates and synchronisation between different linked files, \r\n- Establish a simple and intuitive audit interface for cleaning unnecessary BIM information in projects,\r\n\r\nThe above is done so as a means of preventing the build up of human errors, BIM modelling mistakes and effort during project documentation.\r\n\r\nThe repo is split into 3 parts namely the Revit Plugin, Server and UI, built upon Speckle's object model and APIs.\r\n\r\n## `plugin`\r\n- Revit plugin for BIM modellers to send `Change Requests` for changing the parameters of various BIM families for approval and consumption by BIM managers through the `ui`.\r\n- Change Requests are sent to the `server` which checks for corresponding BIM elements in the Speckle server.\r\n- BIM managers may use this plugin's `Initialise DB` button to send all BIM family information as a library to the `server` which will save all items in a master database for auditing (currently filesystem based, will be subject to change to a NoSQL db / as a Speckle commit)\r\n- Built using `RevitAPI`, `SolidJS`\r\n\r\n## `server`\r\n- Receives `Change Requests` from the `plugin`.\r\n- Using the Revit UUID, finds the corresponding Speckle object sharing this `applicationId`.\r\n- Creates a new Speckle object based on the old Speckle object, consuming parameters and commiting to a `proposal` branch and model for consumption after approval by BIM managers using the `ui`.\r\n- When a request is received on the `initialise_db` endpoint, the `server` creates a master folder mapped to the Speckle stream's model hierarchy to store a master BIM family manifest for each linked model in the project.\r\n- Built using `FastAPI`, `specklepy`, `gql`\r\n\r\n## `ui`\r\n- Business intelligence UI for BIM managers to view, filter, audit, and edit BIM families, across **multiple linked models** in the same project and approve `Change Requests` sent by users.\r\n- `WIP`: `Change Requests` when approved, will allow BIM managers to push family changes for every linked model, allowing full consistency across the project.\r\n- Built using `SolidJS`, `speckle/viewer`\r\n\r\n## Speckle Project Hierarchy\r\n- For this app to work, please structure your project according to the following hierarchy:\r\n  - main\r\n    - main/link1\r\n    - main/link2\r\n    - main/link3\r\n- Refer to this Speckle project as an example: https://app.speckle.systems/projects/58ae34f884\r\n\r\n## Features to be implemented\r\n- [ ] Revit parameter consumption\r\n- [ ] Creating a Speckle model for each dynamically created branch (so it can be viewed from the Speckle dashboard)\r\n\r\n## Team members\r\n- [Bob Lee](https://github.com/boblyx) \r\n- Jason Lee\r\n- Valent TWR\r\n- Evangelina Ong\r\n- Tiffany Tay\r\n- [Jovin Lim](https://github.com/JovinLim)\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboblyx%2Fspeckle-hackathon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fboblyx%2Fspeckle-hackathon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboblyx%2Fspeckle-hackathon/lists"}