{"id":21482081,"url":"https://github.com/vitrivr/vitrivr-ng","last_synced_at":"2025-07-15T12:33:52.741Z","repository":{"id":37470852,"uuid":"79019725","full_name":"vitrivr/vitrivr-ng","owner":"vitrivr","description":"vitrivr NG is a web-based user interface for searching and browsing mixed multimedia collections. It uses cineast as a backend","archived":false,"fork":false,"pushed_at":"2024-06-12T10:32:27.000Z","size":8323,"stargazers_count":16,"open_issues_count":22,"forks_count":24,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-06-12T16:34:16.940Z","etag":null,"topics":["angular","cineast","multimedia-browser","multimedia-retrieval","query-by-example","query-by-sketch","retrieval"],"latest_commit_sha":null,"homepage":"","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/vitrivr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2017-01-15T09:31:16.000Z","updated_at":"2024-05-27T11:52:33.000Z","dependencies_parsed_at":"2023-02-08T05:01:45.955Z","dependency_job_id":"4d98d93e-26e7-46f7-8b3d-cdeb56530db1","html_url":"https://github.com/vitrivr/vitrivr-ng","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitrivr%2Fvitrivr-ng","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitrivr%2Fvitrivr-ng/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitrivr%2Fvitrivr-ng/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitrivr%2Fvitrivr-ng/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vitrivr","download_url":"https://codeload.github.com/vitrivr/vitrivr-ng/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226043469,"owners_count":17564837,"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":["angular","cineast","multimedia-browser","multimedia-retrieval","query-by-example","query-by-sketch","retrieval"],"created_at":"2024-11-23T12:29:49.316Z","updated_at":"2024-11-23T12:29:50.125Z","avatar_url":"https://github.com/vitrivr.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Vitrivr NG\n[![vitrivr - vitrivr-ng](https://img.shields.io/static/v1?label=vitrivr\u0026message=vitrivr-ng\u0026color=blue\u0026logo=github)](https://github.com/vitrivr/vitrivr-ng)\n[![GitHub release](https://img.shields.io/github/release/vitrivr/vitrivr-ng?include_prereleases=\u0026sort=semver\u0026color=2ea44f)](https://github.com/vitrivr/vitrivr-ng/releases/)\n[![License](https://img.shields.io/badge/License-MIT-blueviolet)](#license)\n\nThis directory contains the source code distribution of Vitrivr NG (stands for either 'Angular' or 'Next Generation'). It was created using [Angular](https://angular.io/)\n\nVitrivr NG is a web-based user interface developed to be used with the latest version if [Cineast](https://github.com/vitrivr/cineast). It allows the user to browse in and retrieve from mixed multimedia collections.\n\nFor setup information, consult our [Wiki](https://github.com/vitrivr/vitrivr-ng/wiki)\n\n## Config\n\nWe follow a zero-config approach, where everything has reasonable defaults.\nThere is a `src/config.template.json` file which you can copy to `src/config.json` and modify if you have custom needs.\nThe default values are in the [code](src/app/shared/model/config/config.model.ts).\nInformation about the configuration can be found in [the _slightly outdated_ wiki](https://github.com/vitrivr/vitrivr-ng/wiki/Configuration).\n\n### Secure Connection Config\n\nIn a setup where the [backend](https://github.com/vitrivr/cineast) aka API is available via a _secure_ connection, the following adjustments make vitrivr-ng respect those:\n\n```json\napi: {\n  \"http_secure\": true,\n  \"ws_secure\":true\n}\n```\n\nIt might be necessary to also adjust `host` and `port` values in `api` config.\n\n## Development server\n\nFrom the project folder, run `ng serve` to start a development server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.\nIf you wish to prevent automatic reloading, run `ng serve --live-reload=false`\n\n## Build\n\nRun `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build.\n\n## OpenAPI\n\n### Cineast API\n\nNote: this section is only relevant if you've made changes to the Cineast API and need to udpate the OpenAPI bindings. \n\nIn order to update / generate the OpenApi stubs and data model, run the following command while [Cineast](https://github.com/vitrivr/cineast) is running and\nhaving the OpenApi serving enabled (config option `\"enableRestLiveDoc\": \"true\"` )\n\n`npm run gen-local-api`\n\nThis is an alias for the full-fledged command:\n\n`openapi-generator-cli generate -g typescript-angular -i http://localhost:4567/openapi-specs -o openapi/cineast --skip-validate-spec --additional-properties npmName=@cineast-openapi/api,snapshot=true,ngVersion=13.0.0`\n\nThe assumption for this snippet is, that the Cineast is running on localhost using port 4567. Adjust according to your needs.\n\nThis will break `ng serve` as it will generate imports for a `Set` class which does not exist. Simply remove all such imports which cause errors, the code will work fine.\n\n### DRES Bindings\n\nSince Vitrivr NG might be used in a competition context, we rely on\n[DRES](https://github.com/dres-dev/DRES).\n\nTo update (and / or initially fetch) the DRES client library,\nuse this command:\n\n`npm run gen-dres-client`\n\n## Further help\n\nTo get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).\n\n## Citation\n\nWe kindly ask you to refer to the following paper in publications mentioning or employing vitrivr NG:\n\nRalph Gasser, Luca Rossetto, Heiko Schuldt. _Multimodal multimedia retrieval with Vitrivr_. In Proceedings of the 2019 on International Conference on Multimedia Retrieval, pp. 391-394, Ottawa, Canada, 2019 - Download paper and BibTeX [here](https://dl.acm.org/doi/abs/10.1145/3323873.3326921)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitrivr%2Fvitrivr-ng","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvitrivr%2Fvitrivr-ng","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitrivr%2Fvitrivr-ng/lists"}