{"id":23624821,"url":"https://github.com/hcl-tech-software/domino-rest-adminclient","last_synced_at":"2025-08-23T00:15:27.743Z","repository":{"id":210053052,"uuid":"725574347","full_name":"HCL-TECH-SOFTWARE/domino-rest-adminclient","owner":"HCL-TECH-SOFTWARE","description":"Admin client for the HCL Domino REST API","archived":false,"fork":false,"pushed_at":"2025-02-14T14:53:13.000Z","size":4812,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-02-16T23:30:05.453Z","etag":null,"topics":["admin","domino","react","rest-api"],"latest_commit_sha":null,"homepage":"https://opensource.hcltechsw.com/Domino-rest-api/","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/HCL-TECH-SOFTWARE.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2023-11-30T12:37:47.000Z","updated_at":"2025-02-14T14:52:11.000Z","dependencies_parsed_at":"2023-12-21T06:52:22.759Z","dependency_job_id":"e2e02bfa-c5bc-4a30-9fbf-1300c94ee9d2","html_url":"https://github.com/HCL-TECH-SOFTWARE/domino-rest-adminclient","commit_stats":null,"previous_names":["hcl-tech-software/domino-rest-adminclient"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HCL-TECH-SOFTWARE%2Fdomino-rest-adminclient","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HCL-TECH-SOFTWARE%2Fdomino-rest-adminclient/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HCL-TECH-SOFTWARE%2Fdomino-rest-adminclient/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HCL-TECH-SOFTWARE%2Fdomino-rest-adminclient/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HCL-TECH-SOFTWARE","download_url":"https://codeload.github.com/HCL-TECH-SOFTWARE/domino-rest-adminclient/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239525585,"owners_count":19653362,"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":["admin","domino","react","rest-api"],"created_at":"2024-12-27T21:16:35.241Z","updated_at":"2025-02-18T18:26:44.656Z","avatar_url":"https://github.com/HCL-TECH-SOFTWARE.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HCL Domino REST API Admin Client\n\nThe Domino Rest Admin Client is a web UI that facilitates managing schemas, scopes, and applications using Domino Rest API. By nature, it is built on JavaScript and the React framework, but it is used in a Maven application (Domino Rest API) as a [WebJar](https://www.webjars.org/). This WebJar will be contained in Domino Rest API's Java libraries.\n\nOnce you have Domino Rest API, you can access it on http://localhost:8880/admin/ui.\n\nCheck Contributing for details on how to contribute.\n\n## 📔 Documentation\n- [Using Domino REST API Admin Client](https://opensource.hcltechsw.com/Domino-rest-api/references/usingdominorestapi/administrationui.html)\n- [Contributing](/CONTRIBUTING.md)\n\n## ⬇️ Expected Dependencies\n\nDomino Rest Admin Client uses Maven to build the WebJar. As such, the following dependencies are needed:\n\n| Dependency | Version |\n| --- | --- |\n| Java | 1.8 |\n| maven-clean-plugin | 3.1.0 |\n| maven-jar-plugin | 3.2.2 |\n| exec-maven-plugin | 3.0.0 |\n\nAll these dependencies are listed in the pom.xml file.\n\n`maven-jar-plugin` builds the WebJar.\n\nDomino Rest Admin Client uses `npm` as its package manager. The `exec-maven-plugin` runs these `npm` commands when building the application.\n\n### 🗂️ config.json\n\nThe config.json file contains the configurations for Admin UI and the paths that will be available in the WebJar.\n\n## 🌐 Lit Web Components\n\nWe are now in the process of slowly migrating our current components to Lit 3.0 web components. To build a custom Lit element, please follow the following steps:\n\n1. Place your Lit element file in *src/components/lit-elements*. For example, we currently have Lit element with the tag name `lit-autocomplete`, under the class name `Autocomplete`.\n```javascript\nimport { LitElement, html, css } from 'lit';\n\nclass Autocomplete extends LitElement {\n    // definition of custom lit element goes here\n}\n\ncustomElements.define('lit-autocomplete', Autocomplete)\n\nexport default Autocomplete\n```\n2. Add your Lit element's React counterpart in *src/components/lit-elements/LitElements.tsx* using the `createComponent` method (see [documentation](https://lit.dev/docs/frameworks/react/#createcomponent) for details). For example:\n```typescript\nexport const LitAutocomplete = createComponent({\n  tagName: 'lit-autocomplete',\n  elementClass: Autocomplete,\n  react: React,\n});\n```\n3. From here, you will be able to import the Lit element in a component as another React component:\n```javascript\nimport { LitAutocomplete } from '../lit-elements/LitElements'\n```\n\n### 🗝️ Accessing Values\nTo access the Lit element's properties, create a reference using React's `useRef` hook and pass it onto the Lit element as a prop.\n\n```javascript\nconst autocompleteRef = useRef\u003cany\u003e(null)\n\u003cLitAutocomplete\n    ...options\n    ref={autocompleteRef}\n/\u003e\n```\n\nThe properties are accessible through the Lit element's shadow root.\n\n```javascript\nautocompleteRef.current.shadowRoot.querySelector('input')\n```\n\n### 👠 Shoelace\n\nAs part of our move to web components, we are also using Shoelace, which is built under Lit, for more standard web components. Shoelace has an icon and an icon button; however, we couldn't use import the icons through reference, so we include them in the `IMG_DIR` (check config.dev).\n\nTo use icons with Shoelace, add your icon SVG or PNG to the `IMG_DIR`, and reference that path in the `src` attribute of the Shoelace element. For example:\n```javascript\n\u003csl-icon src=\"${IMG_DIR}/shoelace/copy.svg\"\u003e\u003c/sl-icon\u003e\n```\nSee the [Shoelace documentation](https://shoelace.style/components/icon/#custom-icons) for more details on custom icons.\n\n## 🛠️ Building\n\nTo build, run the following from the main project directory:\n\n### Mac / Linux\n\n`localbuild.sh`\n\n### Windows\n\n`localbuild.cmd`\n\n## License\n\nCopyright 2022-25, HCL America, Inc. under Apache License.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhcl-tech-software%2Fdomino-rest-adminclient","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhcl-tech-software%2Fdomino-rest-adminclient","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhcl-tech-software%2Fdomino-rest-adminclient/lists"}