https://github.com/salte-auth/salte-auth

💻🗝 Authentication for the modern web!
https://github.com/salte-auth/salte-auth

authentication oauth2 openid

Last synced: about 2 months ago
JSON representation

💻🗝 Authentication for the modern web!

• Host: GitHub
• URL: https://github.com/salte-auth/salte-auth
• Owner: salte-auth
• License: mit
• Created: 2016-10-10T17:07:42.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2022-10-18T20:05:40.000Z (about 2 years ago)
• Last Synced: 2024-10-23T00:30:33.699Z (2 months ago)
• Topics: authentication, oauth2, openid
• Language: JavaScript
• Homepage:
• Size: 11.4 MB
• Stars: 106
• Watchers: 6
• Forks: 15
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
**NOTE: This repository is currently in maintenance mode and won't receive any new features!**



  


    

      

      


      


      

    

  





  Authentication for the modern web!





	

		API

		•

		Docs

		•

		Demo

	





  [![NPM Version][npm-version-image]][npm-url]

  [![NPM Downloads][npm-downloads-image]][npm-url]

  [![CI Build][github-actions-image]][github-actions-url]

  [![Coveralls][coveralls-image]][coveralls-url]

  [![semantic-release][semantic-release-image]][semantic-release-url]

  



## Install

```sh

$ npm install @salte-auth/salte-auth

```

## Usage

```js

import { SalteAuth } from '@salte-auth/salte-auth';

import { Auth0 } from '@salte-auth/auth0';

import { Tab } from '@salte-auth/tab';

// Configure SalteAuth with Auth0's url and client id.

const auth = new SalteAuth({

  providers: [

    new Auth0({

      url: 'https://salte-os.auth0.com',

      clientID: '9JTBXBREtckkFHTxTNBceewrnn7NeDd0'

    })

  ],

  handlers: [

    new Tab({

      default: true

    })

  ]

});

// Display an iframe to the user that allows them to login

auth.login('auth0');

```

## Known Issues

_These are issues that we know about, but don't have a clear fix for!_

**There are currently no known issues, thanks for checking!**

[npm-version-image]: https://img.shields.io/npm/v/@salte-auth/salte-auth.svg?style=flat

[npm-downloads-image]: https://img.shields.io/npm/dm/@salte-auth/salte-auth.svg?style=flat

[npm-url]: https://npmjs.org/package/@salte-auth/salte-auth

[github-actions-image]: https://github.com/salte-auth/salte-auth/actions/workflows/ci.yml/badge.svg?branch=main

[github-actions-url]: https://github.com/salte-auth/salte-auth/actions/workflows/ci.yml

[coveralls-image]: https://img.shields.io/coveralls/salte-auth/salte-auth.svg

[coveralls-url]: https://coveralls.io/github/salte-auth/salte-auth?branch=main

[semantic-release-url]: https://github.com/semantic-release/semantic-release

[semantic-release-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg