Readmes updates (#3807)
* updated READMEs * updated READMEs * updated READMEs * feedback * Apply review feedback Co-authored-by: Agnieszka Gancarczyk <agancarc@redhat.com> Co-authored-by: Jon Koops <jonkoops@gmail.com>
This commit is contained in:
parent
8bdabbedb7
commit
c3b08cd601
4 changed files with 20 additions and 3 deletions
14
README.md
14
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).
|
||||
|
|
3
apps/account-ui/README.md
Normal file
3
apps/account-ui/README.md
Normal file
|
@ -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/).
|
|
@ -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)
|
||||
|
||||
|
|
|
@ -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.
|
||||
You'll only have to run this command once, unless you remove the server directory or Keycloak server data.
|
||||
|
|
Loading…
Reference in a new issue