Skip to content

rwth-acis/openidconnect-signin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

55 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

openidconnect-signin

is a custom HTML5 element that makes it really easy to login to an OpenID Connect provider. It displays a button that is optimized for single-page applications. It works with a popup instead of redirects, so the context of your Web application in the user's browser remains the same.

The element is based on lit-element.

Example

  1. Install the dependency
npm install rwth-acis/openidconnect-signin
  1. Import it into your source code
import 'openidconnect-signin/openidconnect-signin.js'
  1. Register an OIDC User-Client at Learning Layers using the account console.
  2. Add the HTML-element with your newly created client-id
<openidconnect-signin clientid="..." scopes="openid profile"></openidconnect-signin>

Visit the Github pages for further documentation. Note: Should the demo using redirect not work properly, you can try it out here instead.

Demo

Either try it out yourself or enjoy this gif that was made with ❤️:

openidconnect-signin in action

Development

Clone this project and install the dependencies.

git clone [email protected]:rwth-acis/openidconnect-signin.git
cd openidconnect-signin
npm install

Refresh Docs

Every time the API or a doc comment changes it is advisable to rebuild the documentation. Run the docs npm script and do not forget to add all docs files to git in case any new files have been created.

npm run docs
git add docs
git commit -am "Update docs"

License

MIT