{"id":19880269,"url":"https://github.com/redlink-gmbh/amsui","last_synced_at":"2025-06-10T19:34:48.754Z","repository":{"id":44576329,"uuid":"351005663","full_name":"redlink-gmbh/amsui","owner":"redlink-gmbh","description":"Search UI elements that already include best practices . The UI is based on Angular Material.","archived":false,"fork":false,"pushed_at":"2022-02-07T10:10:11.000Z","size":2395,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-04-24T01:20:32.183Z","etag":null,"topics":["angular","angular-components","frontend-searching","material","material-design","material-ui","search","search-ui","ui"],"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/redlink-gmbh.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}},"created_at":"2021-03-24T08:40:54.000Z","updated_at":"2022-02-07T09:58:56.000Z","dependencies_parsed_at":"2022-09-03T08:52:02.198Z","dependency_job_id":null,"html_url":"https://github.com/redlink-gmbh/amsui","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redlink-gmbh%2Famsui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redlink-gmbh%2Famsui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redlink-gmbh%2Famsui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redlink-gmbh%2Famsui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/redlink-gmbh","download_url":"https://codeload.github.com/redlink-gmbh/amsui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252046238,"owners_count":21685978,"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","angular-components","frontend-searching","material","material-design","material-ui","search","search-ui","ui"],"created_at":"2024-11-12T17:10:53.233Z","updated_at":"2025-05-02T13:32:04.917Z","avatar_url":"https://github.com/redlink-gmbh.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Getting started\n\nThe Angular Material Search UI, in short AMSUI, is build to deliver search UI components that already include all the best practices.\nThese are needed to guarantee a great search experience for your users.\n\nAs the name already stated, the library is an extensions for the Angular Material library.\n\n## Development instructions\n\nThe library can be used in the development process in three different scenarios:\n\n1. Maintaining, releasing, developing the library itself\n2. Using the library's search service, UI components and the Backend Adapter Service for a MVP-like search application/page.\n3. Using some of the UI components standalone from the library.\n\n## Library development setup\n\nWe use nvm (NodeJS version manager) to be sure that our project works everytime someone else tries to start/edit the AMSUI library.\nIf you are not familiar with nvm, you can find it [here](https://github.com/nvm-sh/nvm).\n\nYou should use the specified version of NodeJS in the [NVM config file](.nvmrc).\nJust execute the command `nvm use` and you are good to go, or you could set up an automatic switch like it is done [here](https://medium.com/@kinduff/automatic-version-switch-for-nvm-ff9e00ae67f3).\n\nFirst, you need to install the npm dependencies.\n\n```\nnpm install\n```\n\nThen, you can build and watch the library with the following command:\n\n```\nnpm run dev:amsui\n```\n\nThe next command copies translations and styles once into the dist folder.\nIf you change a translation or something inside the global style of library, you need to manually run it again.\n\n```\nnpm run copy:all\n```\n\nAt last, the demo project can be started like this:\n\n```\nnpm start\n```\n\n**Important notes:**\n\n- Add prettier formatter on save in intellij products for a better developer experience.\n- To be able to run the demo project with data, you need a Solr index and write a transformer service for the response docs.\n\n## [Documentation](https://dev.redlink.io/amsui)\n\nThe documentation is written within Storybook and it can be found [here](https://dev.redlink.io/amsui).\n\n## [npm library](https://www.npmjs.com/package/@redlink/amsui)\n\nTHe library is published to npm and can be used through installing it via npm.\n\n## Demos\n\n- [Standalone demo usage of library's components](https://dev.redlink.io/amsui-standalone-demo/) -- [source code](https://github.com/redlink-gmbh/amsui-standalone-demo)\n- [Demo with a public API](https://dev.redlink.io/amsui-public-api-demo/) -- [source code](https://github.com/redlink-gmbh/amsui-public-api-demo)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredlink-gmbh%2Famsui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fredlink-gmbh%2Famsui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredlink-gmbh%2Famsui/lists"}