Code Monkey home page Code Monkey logo

auth-react-component's Introduction

Logo

Keycloak with ReactJS

Auth components


NPM version Build Status Known Vulnerabilities

Requirements

  • React, React DOM, keycloak-js

Getting started

Integrate the keycloak with the react

# If using Yarn:
yarn add keycloak-js-react

# If using npm:
npm install --save keycloak-js-react

Import

import KeycloakWrapper from 'keycloak-js-react/components/KeycloakWrapper';

// using require
const KeycloakWrapper = require('keycloak-js-react/components/KeycloakWrapper').default;

Usage

<KeycloakWrapper keycloak={ keycloakInstance } keycloakOptions={{ onLoad: 'check-sso', checkLoginIframeInterval: 1 }} tokenUpdateInterval={300000}>
  <App/>
</KeycloakWrapper>

Development and Contributing

To get started:

  • Fork and clone this repo.
  • Install the dependencies with yarn.
  • Start the development server with yarn start. This will launch a styleguide instance. Open a browser to http://localhost:6060 to preview the React components.
  • Use CTRL-C to exit the styleguide.
  • Use yarn build to generate the compiled component for publishing to npm.

Committing and Pushing changes

This project uses semantic-release to do automatic releases and generate a changelog based on the commit history. Please follow the ESLint convention for commit messages so that we could properly determine the next semantic version number to publish and generate a changelog.

Feel free to open an issue, submit a pull request, or contribute however you would like. Understand that this documentation is still a work in progress, so file an issue or submit a PR to ask questions or make improvements. Thanks!

auth-react-component's People

Contributors

0xhexe avatar aimenbatool avatar armenzg avatar ededals avatar eliperelman avatar helfi92 avatar hrushikeshbodas avatar projectyang avatar snyk-bot avatar

Stargazers

 avatar  avatar  avatar  avatar

auth-react-component's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on Greenkeeper branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please click the 'fix repo' button on account.greenkeeper.io.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.