No description
Find a file
2021-07-14 14:17:57 +02:00
.github Use a Snowpack plugin to check TypeScript types (#844) 2021-07-14 12:43:21 +02:00
.husky Add GIT hooks to run CI tasks before pushing 2021-07-13 15:55:42 +02:00
.storybook Use WebPack 5 for Storybook builds 2021-07-07 17:04:11 +02:00
cypress sessions: added cypress tests review changes 2021-07-14 11:41:04 +01:00
mocks Integrate Prettier into ESLint and fix linting issues 2021-07-13 15:20:36 +02:00
public Switch to NPM as the default package manager 2021-07-07 17:26:50 +02:00
src Use a Snowpack plugin to enable React Fast Refresh (#845) 2021-07-14 14:17:57 +02:00
types Extend tsconfig from Snowpack and fix type errors 2021-05-18 16:50:35 +02:00
.dockerignore add Docker and docker-compose (#456) 2021-03-23 11:07:46 +01:00
.eslintrc.json Integrate Prettier into ESLint and fix linting issues 2021-07-13 15:20:36 +02:00
.gitignore Switch to NPM as the default package manager 2021-07-07 17:26:50 +02:00
.prettierrc.json added initial version of the "help system" (#26) 2020-09-02 09:51:42 +02:00
babel.config.json fixed build by changing it to webpack (#50) 2020-09-01 08:21:47 -04:00
CODE_OF_CONDUCT.md Added code of conduct to project. (#150) 2020-10-07 11:14:55 -04:00
CODING_GUIDELINES.md Add a 'Package Managers' section to the coding guidelines 2021-07-14 00:36:28 +02:00
cypress.json Optimize performance of Cypress tests on CI (#809) 2021-07-08 13:09:29 +02:00
docker-compose.yml add Docker and docker-compose (#456) 2021-03-23 11:07:46 +01:00
Dockerfile Switch to NPM as the default package manager 2021-07-07 17:26:50 +02:00
Gruntfile.js Bump snowpack from 2.11.1 to 2.18.5 2021-07-08 13:30:42 +02:00
import.js removed cypress init spec in favor of node script (#340) 2021-01-28 16:04:48 +01:00
jest.config.ts Integrate Prettier into ESLint and fix linting issues 2021-07-13 15:20:36 +02:00
jest.setup.ts Remove Enzyme from testing suite 2021-07-07 15:40:50 +02:00
LICENSE Initial commit 2020-07-27 14:40:12 -04:00
nginx-default.conf add Docker and docker-compose (#456) 2021-03-23 11:07:46 +01:00
nginx.conf initial move group dialog (#455) 2021-03-29 07:37:47 -04:00
package-lock.json Use a Snowpack plugin to enable React Fast Refresh (#845) 2021-07-14 14:17:57 +02:00
package.json Use a Snowpack plugin to enable React Fast Refresh (#845) 2021-07-14 14:17:57 +02:00
postcss.config.js let post css use all paths (#102) 2020-09-17 11:13:04 -04:00
README.md Use a Snowpack plugin to check TypeScript types (#844) 2021-07-14 12:43:21 +02:00
realm-settings.png fix: added build instructions 2020-08-06 17:11:12 +02:00
security-admin-console-v2-combined.json add Docker and docker-compose (#456) 2021-03-23 11:07:46 +01:00
security-admin-console-v2.json First page within Group section (#108) 2020-09-28 11:58:03 -04:00
snowpack.config.js Use a Snowpack plugin to enable React Fast Refresh (#845) 2021-07-14 14:17:57 +02:00
start.js removed cypress init spec in favor of node script (#340) 2021-01-28 16:04:48 +01:00
tsconfig.json Use a Snowpack plugin to enable React Fast Refresh (#845) 2021-07-14 14:17:57 +02:00

Keycloak Admin Console V2

This project is the next generation of the Keycloak Administration Console. It is written with React and PatternFly 4.

Development Instructions

For development on this project you will need a running Keycloak server listening on port 8180.

  1. Start keycloak

    • Download and run with one command
      $> ./start.js
      
    • or download Keycloak server from keycloak downloads page unpack and run it like:
      $> cd <unpacked download folder>/bin
      $> standalone -Djboss.socket.binding.port-offset=100
      
  2. Go to the clients section of the existing Keycloak Admin Console and add the client

    • like this: realm settings
    • or click on the "Select file" button and import security-admin-console-v2.json
    • or run $> ./import.js
  3. Install dependencies and run:

    $> npm install
    $> npm run start
    

Build and run through Docker

git checkout git@github.com:keycloak/keycloak-admin-ui.git
cd keycloak-admin-ui
docker-compose build
docker-compose up

You can reach the new admin interface at http://localhost

If your Keycloak instance is not on localhost:8180, create a file .env with the following:

KEYCLOAK_ENDPOINT=https:\/\/remoteinstance.keycloak.com

Additionally there are some nice scripts to format and lint

$> npm run lint

To switch to a RH-SSO themed version of this console you can run:

$> npx grunt switch-rh-sso

To switch back just do a git checkout public

Keycloak UI Test Suite in Cypress

This repository contains the UI tests for Keycloak developed with Cypress framework

Run the test suite

Prerequisites

via Cypress Test Runner

By using npx:

note: npx is included with npm > v5.2 or can be installed separately.

npx cypress open

After a moment, the Cypress Test Runner will launch:

image

via terminal

By executing:

$(npm bin)/cypress run

...or...

./node_modules/.bin/cypress run

...or... (requires npm@5.2.0 or greater)

npx cypress run

To execute a specific test on a specific browser run:

cypress run --spec "cypress/integration/example-test.spec.js" --browser chrome

note: the complete list of parameters can be found in the official Cypress documentation.

Project Structure

/assets (added to .gitignore)
  /videos - if test fails, the video is stored here
  /screenshots - if test fails, the screenshot is stored here
/cypress
  /fixtures - external pieces of static data that can be used by your tests
  /integration - used for test files (supported filetypes are .js, .jsx, .coffee and .cjsx)
  /plugins
    - index.js - extends Cypress behaviour, custom plugins are imported before every single spec file run
  /support - reusable behaviour
    - commands.js - custom commands
    - index.js - runs before each test file

/cypress.json - Cypress configuration file
/jsconfig.json - Cypress code autocompletion is enabled here

note: More about the project structure in the official Cypress documentation.

License