Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/keycloakify/keycloakify-starter-webpack
🔑 Keycloakify Projects Starter Template for Webpack
https://github.com/keycloakify/keycloakify-starter-webpack
Last synced: about 1 month ago
JSON representation
🔑 Keycloakify Projects Starter Template for Webpack
- Host: GitHub
- URL: https://github.com/keycloakify/keycloakify-starter-webpack
- Owner: keycloakify
- License: mit
- Created: 2024-02-13T02:31:09.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-11-18T04:26:18.000Z (about 2 months ago)
- Last Synced: 2024-11-18T05:28:20.032Z (about 2 months ago)
- Language: TypeScript
- Homepage: https://keycloakify.dev
- Size: 1.37 MB
- Stars: 5
- Watchers: 1
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🚀 Keycloakify v11 starter 🚀
This starter is based on Webpack. There is also [a Vite based starter](https://github.com/keycloakify/keycloakify-starter).
# Quick start
```bash
git clone https://github.com/keycloakify/keycloakify-starter-webpack
cd keycloakify-starter-webpack
yarn install # Or use pnpm or bun (but not npm), just be sure to delete the yarn.lock if you do.
```
# Testing the theme locally
[Documentation](https://docs.keycloakify.dev/v/v10/testing-your-theme)
# How to customize the theme
[Documentation](https://docs.keycloakify.dev/v/v10/customization-strategies)
# Building the theme
You need to have [Maven](https://maven.apache.org/) installed to build the theme (Maven >= 3.1.1, Java >= 7).
The `mvn` command must be in the $PATH.
- On macOS: `brew install maven`
- On Debian/Ubuntu: `sudo apt-get install maven`
- On Windows: `choco install openjdk` and `choco install maven` (Or download from [here](https://maven.apache.org/download.cgi))
```bash
npm run build-keycloak-theme
```
Note that by default Keycloakify generates multiple .jar files for different versions of Keycloak.
You can customize this behavior, see documentation [here](https://docs.keycloakify.dev/targeting-specific-keycloak-versions).
# GitHub Actions
The starter comes with a generic GitHub Actions workflow that builds the theme and publishes
the jars [as GitHub releases artifacts](https://github.com/keycloakify/keycloakify-starter-webpack/releases/tag/v10.0.0).
To release a new version **just update the `package.json` version and push**.
To enable the workflow go to your fork of this repository on GitHub then navigate to:
`Settings` > `Actions` > `Workflow permissions`, select `Read and write permissions`.
# Ejecting from Create React App
This setup is based on Create React App however you can eject it into a custom Webpack setup with:
```bash
npx react-scripts eject
```