{"id":20301636,"url":"https://github.com/lowes/product-viewer","last_synced_at":"2025-04-11T13:36:44.109Z","repository":{"id":37501823,"uuid":"454179055","full_name":"lowes/product-viewer","owner":"lowes","description":null,"archived":false,"fork":false,"pushed_at":"2023-03-15T00:22:21.000Z","size":86319,"stargazers_count":4,"open_issues_count":10,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-25T09:49:26.439Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://3dviewer.3dmanager.app/","language":"TypeScript","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/lowes.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":"2022-01-31T21:40:10.000Z","updated_at":"2023-03-04T10:54:28.000Z","dependencies_parsed_at":"2024-11-14T16:33:43.630Z","dependency_job_id":"b04ab92c-de9d-4016-96f1-319dc52c4b82","html_url":"https://github.com/lowes/product-viewer","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lowes%2Fproduct-viewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lowes%2Fproduct-viewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lowes%2Fproduct-viewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lowes%2Fproduct-viewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lowes","download_url":"https://codeload.github.com/lowes/product-viewer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248410206,"owners_count":21098772,"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-14T16:26:58.178Z","updated_at":"2025-04-11T13:36:44.077Z","avatar_url":"https://github.com/lowes.png","language":"TypeScript","readme":"# Product Viewer\n\nThis is a monorepo containing projects related to 3D product rendering and web-based mixed reality. All of the projects can be found under the `packages/` directory, and each have their own readme.\n\n## Packages\n\n-   product-viewer: A web component used to view 3D product assets. Currently an npm package on the GitHub registry.\n\n-   viewer-demos: A react web app demonstrating the features of product-viewer and sample implementations. It is hosted at [3dviewer.3dmanager.app](https://3dviewer.3dmanager.app/)\n\n-   viewer-assets: contains shared assets for use across all product-viewer projects\n\n## Using `product-viewer`\n\nThe product viewer is available as an npm package for import into a JavaScript or TypeScript project.\n\nSee the `product-viewer` package [readme](packages/product-viewer/README.md) for details.\n\n## Development\n\nThis project uses lerna to syncronize multiple sub projects. Once the \"root\" project is installed, it will manage cross-project dependencies, assets, and npm packages.\n\n1. `npm run setup`\n2. `npm run start`\n\nThe `start` command in the root directory will build the product-viewer, and then launch the viewer-demos react app in a dev hot-reload mode.\n\nTo run the product-viewer project by itself for faster development iteration:\n\n1. `npm run setup`\n2. `npm run serve-viewer`\n\nThis will launch a dev server with a basic html page containing just a viewer component.\n\nNOTE: You need to run the root `setup` or `bootstrap` script before launching the viewer by itself as it installs cross-dependencies and shared assets.\n\n## Recommended Software\n\nNodeJS version: \u003e=10.0.0\n\nWe recommend using VS Code for development, and opening the workspace file `.product-viewer.code-workspace` to improve subproject organization within the editor.\n\nVS Code Plugins:\n\n-   Prettier - Code formatter - https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode\n-   vscode-styled-components - https://marketplace.visualstudio.com/items?itemName=jpoissonnier.vscode-styled-components\n-   CSS-in-JS - https://marketplace.visualstudio.com/items?itemName=paulmolluzzo.convert-css-in-js\n-   ESLint - https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint\n-   EditorConfig - https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig\n\n## Available Scripts\n\n| Command             | Description                                                                                             |\n| ------------------- | ------------------------------------------------------------------------------------------------------- |\n| `npm run setup`     | Installs root dependencies and bootstraps the projects                                                  |\n| `npm run bootstrap` | Runs `install`, `prepublish`, and `prepare` commands in each project, and symlinks sibling dependencies |\n| `npm run start`     | Bootstraps the projects, creates a dev build, and then starts the viewer-demos dev server               |\n| `npm run build`     | Runs the build script for each package, if present                                                      |\n| `npm run clean`     | Removes `node_modules` directory from all packages                                                      |\n| `npm run lint`      | Checks for lint issues in each package                                                                  |\n| `npm run lint:fix`  | Fixes lint issues in each package                                                                       |\n| `npm run test`      | Runs tests in each package                                                                              |\n\n\n## Demo\n\nhttps://3dviewer.3dmanager.app/\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flowes%2Fproduct-viewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flowes%2Fproduct-viewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flowes%2Fproduct-viewer/lists"}