{"id":17332697,"url":"https://github.com/kitwaremedical/volviewcustomapptemplate","last_synced_at":"2025-04-14T18:12:31.706Z","repository":{"id":193123741,"uuid":"688166186","full_name":"KitwareMedical/VolViewCustomAppTemplate","owner":"KitwareMedical","description":"VolView custom app template using file overrides to customize a webapp built using Vite","archived":false,"fork":false,"pushed_at":"2025-03-11T23:55:58.000Z","size":443,"stargazers_count":3,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-14T18:12:23.344Z","etag":null,"topics":["volview-custom-application"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KitwareMedical.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-09-06T19:35:59.000Z","updated_at":"2025-04-08T14:17:33.000Z","dependencies_parsed_at":"2023-09-06T22:30:33.302Z","dependency_job_id":"9879c54d-5860-4b50-a27a-f7da30df3d64","html_url":"https://github.com/KitwareMedical/VolViewCustomAppTemplate","commit_stats":null,"previous_names":["floryst/customvolviewtemplate","kitwaremedical/volviewcustomapptemplate"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KitwareMedical%2FVolViewCustomAppTemplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KitwareMedical%2FVolViewCustomAppTemplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KitwareMedical%2FVolViewCustomAppTemplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KitwareMedical%2FVolViewCustomAppTemplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KitwareMedical","download_url":"https://codeload.github.com/KitwareMedical/VolViewCustomAppTemplate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248933340,"owners_count":21185460,"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":["volview-custom-application"],"created_at":"2024-10-15T14:58:38.347Z","updated_at":"2025-04-14T18:12:31.676Z","avatar_url":"https://github.com/KitwareMedical.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# VolView Custom Application Template\n\nThis repository provides a template for starting the development of custom VolView applications.\n\n[VolView](https://kitware.github.io/VolView/#what-is-volview) is an open source radiological viewer\ndeveloped for clinical professionals.\n\nThis template utilizes Vite and file overrides to enable easy customization.\n\n\u003e [!WARNING]\n\u003e This project is provided \"as-is\" and is actively being developed. Backward compatibility is\n\u003e not guaranteed, and the API or functionality may change without prior notice between versions.\n\n## Getting Started\n\n1. Clone the repository: `git clone https://github.com/KitwareMedical/VolViewCustomAppTemplate.git`\n1. Edit `package.json` to configure the version of \"volview\" that you want to customize.\n1. Run `npm install`.\n\nAfter installation, check the `app/` directory for a sample file override that modifies some configuration keys.\n\nAll vite commands are supported:\n- `npm run dev`: start the development server\n- `npm run build`: build the application\n- `npm run preview`: preview a production build of the application\n\n## Override Behavior\n\nFile overriding is the primary customization behavior of this template. Files inside the override directory must match the relative file path in the core repository in order to be overridden.\n\nImports can be classified into 3 types:\n- **override-to-override**: an override file imports from another override file. No change in behavior.\n- **override-to-core**: override files can import core files, even if there is an override file for that core file. This allows override files to extend core files merely by importing.\n- **core-to-core**: core files importing other core files works as-is, unless an override file is present in the override directory.\n\n## Targeting a different project name + repo\n\nThis repo by default customizes the \"volview\" project as specified in `package.json`, with an override folder called `app/`.\nTo rename the customization target or the override folder, follow these steps:\n- Edit the package name \"volview\" in `package.json`.\n- Edit `customizeUtils/custom-app.config.cjs` with the new package name and/or override folder.\n- Edit `tsconfig.json` to change instances of \"volview\" if you've changed the package name, and \"app\" if you've changed the override folder.\n- Edit `patches/vite*.patch` to change instances of \"volview\" if you've changed the package name.\n\n## Contributing\n\nWe welcome contributions through Pull Requests.\n\n\u003e [!TIP]\n\u003e Due to limited continuous integration infrastructure, we recommend that developers carefully\n\u003e describe their changes and ensure thorough testing before submitting.\n\n## License\n\nIt is covered by the Apache License, Version 2.0.\n\nThe license file was added on 2024-09-25, but you may consider that the license applies to all prior revisions as well.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitwaremedical%2Fvolviewcustomapptemplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkitwaremedical%2Fvolviewcustomapptemplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitwaremedical%2Fvolviewcustomapptemplate/lists"}