https://github.com/hcl-tech-software/domino-rest-adminclient

Admin client for the HCL Domino REST API
https://github.com/hcl-tech-software/domino-rest-adminclient

admin domino react rest-api

Last synced: 8 days ago
JSON representation

Admin client for the HCL Domino REST API

• Host: GitHub
• URL: https://github.com/hcl-tech-software/domino-rest-adminclient
• Owner: HCL-TECH-SOFTWARE
• License: apache-2.0
• Created: 2023-11-30T12:37:47.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-18T12:59:42.000Z (17 days ago)
• Last Synced: 2024-12-20T12:15:39.503Z (15 days ago)
• Topics: admin, domino, react, rest-api
• Language: TypeScript
• Homepage: https://opensource.hcltechsw.com/Domino-rest-api/
• Size: 4.09 MB
• Stars: 1
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# HCL Domino REST API Admin Client

The 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.

Once you have Domino Rest API, you can access it on http://localhost:8880/admin/ui.

Check Contributing for details on how to contribute.

## 📔 Documentation

- [Using Domino REST API Admin Client](https://opensource.hcltechsw.com/Domino-rest-api/references/usingdominorestapi/administrationui.html)

- [Contributing](/CONTRIBUTING.md)

## ⬇️ Expected Dependencies

Domino Rest Admin Client uses Maven to build the WebJar. As such, the following dependencies are needed:

| Dependency | Version |

| --- | --- |

| Java | 1.8 |

| maven-clean-plugin | 3.1.0 |

| maven-jar-plugin | 3.2.2 |

| exec-maven-plugin | 3.0.0 |

All these dependencies are listed in the pom.xml file.

`maven-jar-plugin` builds the WebJar.

Domino Rest Admin Client uses `npm` as its package manager. The `exec-maven-plugin` runs these `npm` commands when building the application.

### 🗂️ config.json

The config.json file contains the configurations for Admin UI and the paths that will be available in the WebJar.

## Lit Web Components

We are now using Lit 3.0 for web components. To build a custom Lit element, follow the following steps:

1. Place your Lit element file in *src/components/lit-elements*.

2. Add your Lit element's React counterpart in *src/components/lit-elements/LitElements.tsx* using the `createComponent` method.

3. Import the created React component in the appropriate TSX, e.g. `import { LitAutocomplete } from '../lit-elements/LitElements'`.

## 🛠️ Building

To build, run the following from the main project directory:

Mac / linux

`localbuild.sh`

Windows

`localbuild.cmd`

## License

Copyright 2022-23, HCL America, Inc. under Apache License.