diff --git a/README.md b/README.md index 708ab8d6..596900ba 100644 --- a/README.md +++ b/README.md @@ -87,12 +87,18 @@ Tested with the following Keycloak versions: This tool will be maintained to stay compatible with Keycloak v11 and up, however, the default pages you will get (before you customize it) will always be the ones of Keycloak v11. -Install [Maven](https://maven.apache.org/) which is needed for the theme build process. - This tool assumes you are bundling your app with Webpack (tested with 4.44.2) . It assumes there is a `build/` directory at the root of your react project directory containing a `index.html` file and a `build/static/` directory generated by webpack. For more information see [this issue](https://github.com/InseeFrLab/keycloakify/issues/5#issuecomment-832296432) + +**All this is defaults with [`create-react-app`](https://create-react-app.dev)** (tested with 4.0.3) + +- `mvn` ([Maven](https://maven.apache.org/)), `rm`, `mkdir`, `wget`, `unzip` are assumed to be available. +- `docker` must be up and running when running `yarn keycloak`. + +On Windows you'll have to use [WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10). + ## My framework doesn’t seem to be supported, what can I do? Currently Keycloakify is only compatible with `create-react-app` apps. @@ -301,13 +307,6 @@ If you need to customize pages that are not supported yet or if you need to impl [Here is a demo repo](https://github.com/garronej/keycloakify-demo-app) to show how to automate the building and publishing of the theme (the .jar file). - - -**All this is defaults with [`create-react-app`](https://create-react-app.dev)** (tested with 4.0.3) - -- For building the theme: `mvn` (Maven) must be installed (but you can build the theme in the CI) -- For testing the theme in a local Keycloak container (which is not mandatory for development): - `rm`, `mkdir`, `wget`, `unzip` are assumed to be available and `docker` up and running. # Limitations ## `process.env.PUBLIC_URL` not supported.