From c3b08cd601a18e4c9a843b3e852cdf51a7a12a05 Mon Sep 17 00:00:00 2001 From: agagancarczyk Date: Thu, 1 Dec 2022 14:19:06 +0000 Subject: [PATCH] Readmes updates (#3807) * updated READMEs * updated READMEs * updated READMEs * feedback * Apply review feedback Co-authored-by: Agnieszka Gancarczyk Co-authored-by: Jon Koops --- README.md | 14 ++++++++++++++ apps/account-ui/README.md | 3 +++ apps/admin-ui/README.md | 4 ++-- apps/keycloak-server/README.md | 2 +- 4 files changed, 20 insertions(+), 3 deletions(-) create mode 100644 apps/account-ui/README.md diff --git a/README.md b/README.md index e6d1f732a4..045fe705ea 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,20 @@ This repository contains the UIs and related libraries of the Keycloak project. +## Repository structure + + ├── apps + │ ├── account-ui # Account UI for account management i.e controlling password and account access, tracking and managing permissions + │ ├── admin-ui # Admin UI for handling login, registration, administration, and account management + │ └── keycloak-server # Keycloak server for local development of UIs + ├── keycloak-theme # Maven build for the Keycloak theme + ├── libs + │ ├── keycloak-admin-client # Keycloak Admin Client library for Keycloak REST API + │ ├── keycloak-js # Keycloak JS library for securing HTML5/JavaScript applications + │ └── keycloak-masthead # Keycloak Masthead library for an easy way to bring applications into the Keycloak ecosystem, allow users to access + │ # and manage security for those applications and manage authorization of resources + ├── ... + ## Data processing Red Hat may process information including business contact information and code contributions as part of its participation in the project, data is processed in accordance with [Red Hat Privacy Statement](https://www.redhat.com/en/about/privacy-policy). diff --git a/apps/account-ui/README.md b/apps/account-ui/README.md new file mode 100644 index 0000000000..2eb66bc077 --- /dev/null +++ b/apps/account-ui/README.md @@ -0,0 +1,3 @@ +# Keycloak Account UI + +This project is the next generation of the Keycloak Account UI. It is written with React and [PatternFly 4](https://www.patternfly.org/v4/) and uses [Vite](https://vitejs.dev/guide/). diff --git a/apps/admin-ui/README.md b/apps/admin-ui/README.md index 913e2037fd..362ed9ae05 100644 --- a/apps/admin-ui/README.md +++ b/apps/admin-ui/README.md @@ -1,6 +1,6 @@ # Keycloak Admin UI -This project is the next generation of the Keycloak Administration UI. It is written with React and [PatternFly 4](https://www.patternfly.org/v4/). +This project is the next generation of the Keycloak Administration UI. It is written with React and [PatternFly 4](https://www.patternfly.org/v4/) and uses [Vite](https://vitejs.dev/guide/) and [Cypress](https://docs.cypress.io/guides/overview/why-cypress). ## Development @@ -45,6 +45,7 @@ Every time you create a commit it should be automatically linted and formatted f ```bash npm run lint ``` + ## Integration testing with Cypress This repository contains integration tests developed with the [Cypress framework](https://www.cypress.io/). @@ -73,4 +74,3 @@ For more information about the Cypress command-line interface consult [the docum You can find information about the project structure in the [official Cypress documentation](https://docs.cypress.io/guides/core-concepts/writing-and-organizing-tests#Folder-structure). Read more about [how to write tests](./cypress/WRITING_TESTS.md) - diff --git a/apps/keycloak-server/README.md b/apps/keycloak-server/README.md index 8c2c993124..e1dc2b2ba5 100644 --- a/apps/keycloak-server/README.md +++ b/apps/keycloak-server/README.md @@ -26,4 +26,4 @@ Wait for the Keycloak server to be up and running and run the following command npm run import-client ``` -You'll only have to run this command once, unless you remove the server directory or Keycloak server data. \ No newline at end of file +You'll only have to run this command once, unless you remove the server directory or Keycloak server data.