From 4ceeb0ed49c0a7f0e50062c3a8a17b84f706c7f1 Mon Sep 17 00:00:00 2001 From: dennisvang <29799340+dennisvang@users.noreply.github.com> Date: Fri, 28 Aug 2026 17:10:11 +0200 Subject: [PATCH 1/2] update repo name in readme and contributing file changed from FAIRDataPoint-client-redux to FAIRDataPoint-UI before making the repo public --- CONTRIBUTING.md | 2 +- README.md | 20 ++++++++++---------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 46d92bf..2704002 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,4 +17,4 @@ If a PR gets very big, split it up into smaller PRs that can be reviewed separat To reduce the maintenance burden, we aim to minimize the number of external dependencies. If external dependencies cannot be avoided, prefer well-supported projects with large numbers of contributors. -[pull requests]: https://github.com/FAIRDataTeam/FAIRDataPoint-client-redux/pulls +[pull requests]: https://github.com/FAIRDataTeam/FAIRDataPoint-UI/pulls diff --git a/README.md b/README.md index 893fe70..7d5e4ae 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -# FAIR Data Point client redux +# FAIR Data Point UI -A browser-based client for FAIR Data Point (FDP) administration. +A browser-based user interface for FAIR Data Point (FDP) administration. > [!NOTE] -> This client replaces the [legacy FDP client], which has been archived. +> FAIRDataPoint-UI replaces the legacy [FAIRDataPoint-client], which is scheduled to be archived. @@ -20,7 +20,7 @@ The main goal of the FDP client is to enable basic administration of the FDP, in ### Quickstart -The FDP client is published as a Docker image ([fairdata/fairdatapoint-client-redux]) and is designed to run in a container. +The FDP client is published as a Docker image ([fairdata/fairdatapoint-ui]) and is designed to run in a container. The Docker image is based on the official [Nginx hardened image], configured as a static file server listening on port `8080`. One way to deploy the client is using [Docker Compose], as follows: @@ -28,8 +28,8 @@ One way to deploy the client is using [Docker Compose], as follows: ```yaml # compose.yaml services: - fdp-client-redux: - image: fairdata/fairdatapoint-client-redux + fdp-ui: + image: fairdata/fairdatapoint-ui # ... volumes: # Override the default runtime config to specify the URL of the FDP API @@ -91,7 +91,7 @@ Here's how to install project dependencies and run the development server, provi The browser-based client application needs an API, provided by a FAIR Data Point (FDP), to function properly. The URL for the primary API endpoint is defined in the [public/config.json] file and defaults to `http://localhost:8080`. -The default configuration is convenient for local development using the `dev/fdp-client-redux` stack from the [FAIRDataTeam/compose] repository. +The default configuration is convenient for local development using the `dev/fdp-ui` stack from the [FAIRDataTeam/compose] repository. However, it is also possible to override the default [public/config.json] file locally, if desired. This can be achieved by creating a `public/config.local.json` file. If such a file exists, it is picked up automatically by the Vite development server. @@ -105,9 +105,9 @@ For example, you could use this to point the client to an actual FDP on the web, Note that the `config.local.json` file is ignored by `git`. -[legacy FDP client]: https://github.com/FAIRDataTeam/FAIRDataPoint-client +[FAIRDataPoint-client]: https://github.com/FAIRDataTeam/FAIRDataPoint-client [FDP 1.2 specification]: https://specs.fairdatapoint.org -[FAIRDataTeam/compose]: https://github.com/FAIRDataTeam/compose/tree/master/fdp/ephemeral/v1/dev/fdp-client-redux +[FAIRDataTeam/compose]: https://github.com/FAIRDataTeam/compose/tree/master/fdp/ephemeral/v1/dev/fdp-ui [npm]: https://docs.npmjs.com/cli/v11/commands [npm clean-install]: https://docs.npmjs.com/cli/v11/commands/npm-ci [npm install]: https://docs.npmjs.com/cli/v11/commands/npm-install @@ -117,7 +117,7 @@ Note that the `config.local.json` file is ignored by `git`. [vite development server]: https://vite.dev/guide/cli#dev-server [dotenv]: https://github.com/motdotla/dotenv [vite docs]: https://vite.dev/guide/env-and-mode#env-files -[fairdata/fairdatapoint-client-redux]: https://hub.docker.com/r/fairdata/fairdatapoint-client-redux +[fairdata/fairdatapoint-ui]: https://hub.docker.com/r/fairdata/fairdatapoint-ui [Nginx hardened image]: https://hub.docker.com/hardened-images/catalog/dhi/nginx [Docker Compose]: https://docs.docker.com/compose/ [Fetch API]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API From d2e305beb56928a887711979326d0baa3d948a59 Mon Sep 17 00:00:00 2001 From: dennisvang <29799340+dennisvang@users.noreply.github.com> Date: Fri, 28 Aug 2026 17:23:25 +0200 Subject: [PATCH 2/2] replace 'client' in readme text by 'UI' --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 7d5e4ae..2b19284 100644 --- a/README.md +++ b/README.md @@ -3,27 +3,27 @@ A browser-based user interface for FAIR Data Point (FDP) administration. > [!NOTE] -> FAIRDataPoint-UI replaces the legacy [FAIRDataPoint-client], which is scheduled to be archived. +> FAIRDataPoint-UI replaces the legacy [FAIRDataPoint-client], which will be archived. - + -## FAIR Data Point Client +## FAIR Data Point User Interface -The FAIR Data Point (FDP) _client_ provides a web-based user interface that makes it easier for humans to interact with a FAIR Data Point by hiding the interactions with the FDP API. -The client is a JavaScript (TypeScript) application that runs entirely in the browser, without any server-side rendering. -Under the hood, the FDP client uses the JavaScript [Fetch API] to make HTTP requests to a remote FDP API that complies with the [FDP 1.2 specification]. -The main goal of the FDP client is to enable basic administration of the FDP, inspection of FDP content, and execution of simple queries. +The FAIR Data Point _User Interface_ (FDP UI) provides a web-based user interface that makes it easier for humans to interact with a FAIR Data Point by hiding the interactions with the FDP API. +The UI is a JavaScript (TypeScript) application that runs entirely in the browser, without any server-side rendering. +Under the hood, the FDP UI uses the JavaScript [Fetch API] to make HTTP requests to a remote FDP API that complies with the [FDP 1.2 specification]. +The main goal of the FDP UI is to enable basic administration of the FDP, inspection of FDP content, and execution of simple queries. > [!NOTE] -> The FDP client was not designed for bulk operations or advanced queries. +> The FDP UI was not designed for bulk operations or advanced queries. > Those are best performed by direct interaction with the FDP API. ### Quickstart -The FDP client is published as a Docker image ([fairdata/fairdatapoint-ui]) and is designed to run in a container. +The FDP UI is published as a Docker image ([fairdata/fairdatapoint-ui]) and is designed to run in a container. The Docker image is based on the official [Nginx hardened image], configured as a static file server listening on port `8080`. -One way to deploy the client is using [Docker Compose], as follows: +One way to deploy the UI is using [Docker Compose], as follows: ```yaml # compose.yaml @@ -49,7 +49,7 @@ where `my.config.json` is a custom runtime configuration file that defines the p The custom CSS file and custom logo are both optional. -It is also possible to run the FDP client application from source, but this is only recommended for client development purposes. +It is also possible to run the FDP UI application from source, but this is only recommended for UI development purposes. ### Setting up a development machine @@ -88,7 +88,7 @@ Here's how to install project dependencies and run the development server, provi #### App configuration for development -The browser-based client application needs an API, provided by a FAIR Data Point (FDP), to function properly. +The browser-based UI application needs an API, provided by a FAIR Data Point (FDP), to function properly. The URL for the primary API endpoint is defined in the [public/config.json] file and defaults to `http://localhost:8080`. The default configuration is convenient for local development using the `dev/fdp-ui` stack from the [FAIRDataTeam/compose] repository. @@ -96,7 +96,7 @@ However, it is also possible to override the default [public/config.json] file l This can be achieved by creating a `public/config.local.json` file. If such a file exists, it is picked up automatically by the Vite development server. -For example, you could use this to point the client to an actual FDP on the web, as follows: +For example, you could use this to point the UI to an actual FDP on the web, as follows: ```yaml # public/config.local.json