{"id":19307237,"url":"https://github.com/richplastow/cluster-viewer","last_synced_at":"2025-10-25T10:41:58.570Z","repository":{"id":184180740,"uuid":"670501665","full_name":"richplastow/cluster-viewer","owner":"richplastow","description":"Three.js + Vue 3 .glb viewer, with buttons to cluster objects by shape or color.","archived":false,"fork":false,"pushed_at":"2024-05-08T16:23:03.000Z","size":9581,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-18T12:53:45.661Z","etag":null,"topics":["drie","glb","gltf","threejs","vue"],"latest_commit_sha":null,"homepage":"https://richplastow.com/cluster-viewer/","language":"Vue","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/richplastow.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}},"created_at":"2023-07-25T07:39:09.000Z","updated_at":"2025-06-12T07:35:19.000Z","dependencies_parsed_at":"2024-05-08T17:47:31.216Z","dependency_job_id":"9209fd54-5ddc-4a97-a183-fa779b916b21","html_url":"https://github.com/richplastow/cluster-viewer","commit_stats":null,"previous_names":["richplastow/cluster-viewer"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/richplastow/cluster-viewer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/richplastow%2Fcluster-viewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/richplastow%2Fcluster-viewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/richplastow%2Fcluster-viewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/richplastow%2Fcluster-viewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/richplastow","download_url":"https://codeload.github.com/richplastow/cluster-viewer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/richplastow%2Fcluster-viewer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280943421,"owners_count":26417747,"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","status":"online","status_checked_at":"2025-10-25T02:00:06.499Z","response_time":81,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["drie","glb","gltf","threejs","vue"],"created_at":"2024-11-10T00:10:09.133Z","updated_at":"2025-10-25T10:41:58.523Z","avatar_url":"https://github.com/richplastow.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cluster-viewer\n\n__Three.js + Vue 3 .glb viewer, with buttons to cluster objects by shape or color.__\n\n- __Version:__ 1.0.1\n- __Repo:__ \u003chttps://github.com/richplastow/cluster-viewer\u003e\n- __Homepage:__ \u003chttps://richplastow.com/cluster-viewer\u003e\n\n## Approach\n\n- A bare-bones solution, with tidy code and a presentable UI\n- Keep within the `npm init vue@latest` guardrails, for a 'standard' Vue 3 app\n- The app is simple enough not to need a UI library or global state system\n- Allows for slightly updated versions of the glTF models to be swapped in\n- Heads toward a more general purpose app, which can deal with any glTF model\n\n## Next steps\n\n1. __Accessibility:__ Add aria-roles, and test and improve text-to-speech and\n   keyboard access\n2. __Internationalization:__ Currently UI text is hard coded in British English\n3. __Tests and Documentation:__ More unit tests and end-to-end tests, and better\n   [JSDoc](https://jsdoc.app/) documentation throughout (also, refactoring)\n4. __Performance:__ In terms of bundle/chink size, Lighthouse TTI, animation FPS\n5. __Orbit Controls:__ Limit how far the user can zoom, and provide a reset\n6. __SEO:__ Add Open Graph metadata, for better searchability and social media\n   previews - and then add a share button\n7. __Offline Mode:__ for iOS's 'Add to Home Screen', maybe with a service worker\n8. __Icons:__ A full set of icons and native theme, eg using\n   [RealFaviconGenerator](https://realfavicongenerator.net)\n9. __Error Handling:__ Show user-friendly error popups on unhandled exceptions,\n   or [Sentry](https://sentry.io/) ...the usage analytics would be interesting\n10. __Tidier Clusters:__ They should stack up in size-order, and all sit on the\n    ground plane\n11. __Model Upload:__ Let the user upload or link to any glTF file\n12. __Settings Popup:__ For example, set language, theme and animation speed\n\n## Recommended IDE Setup\n\n[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).\n\n## Type Support for `.vue` Imports in TS\n\nTypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.\n\nIf the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:\n\n1. Disable the built-in TypeScript Extension\n    1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette\n    2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`\n2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.\n\n## Customize configuration\n\nSee [Vite Configuration Reference](https://vitejs.dev/config/).\n\n## Project Setup\n\n```sh\nnpm install\n```\n\n### Compile and Hot-Reload for Development\n\n```sh\nnpm run dev\n```\n\n### Type-Check, Compile, Minify and Serve Locally for Production\n\n```sh\nnpm start\n```\n\n### Run Unit Tests with [Vitest](https://vitest.dev/)\n\n```sh\nnpm run test:unit\n```\n\n### Run End-to-End Tests with [Playwright](https://playwright.dev)\n\n```sh\n# Install browsers for the first run\nnpx playwright install\n\n# When testing on CI, must build the project first\nnpm run build\n\n# Runs the end-to-end tests\nnpm run test\n# Runs the tests only on Chromium\nnpm run test -- --project=chromium\n# And also just a specific file's tests\nnpm run test -- e2e/02-screenshots.spec.ts --project=chromium\n# Runs the tests in debug mode\nnpm run test -- --debug\n```\n\n### Lint with [ESLint](https://eslint.org/)\n\n```sh\nnpm run lint\n```\n\n\u003c!-- 188,300,987 bytes (230.6 MB on disk) for 13,822 items --\u003e\n\u003c!-- 193,381,429 bytes (231.2 MB on disk) for 13,904 items after `npm i @vueuse/core` --\u003e\n\u003c!-- 194,472,829 bytes (232.3 MB on disk) for 13,904 items --\u003e\n\u003c!-- 194,472,829 bytes (232.3 MB on disk) for 13,904 items --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frichplastow%2Fcluster-viewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frichplastow%2Fcluster-viewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frichplastow%2Fcluster-viewer/lists"}