https://github.com/sergeylukin/openid-steam

Simple API for Steam web authentication
https://github.com/sergeylukin/openid-steam

Last synced: 27 days ago
JSON representation

Simple API for Steam web authentication

• Host: GitHub
• URL: https://github.com/sergeylukin/openid-steam
• Owner: sergeylukin
• License: mit
• Created: 2019-01-05T23:53:20.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-07-13T22:06:37.000Z (over 4 years ago)
• Last Synced: 2024-04-08T18:22:04.271Z (9 months ago)
• Language: JavaScript
• Homepage:
• Size: 9.77 KB
• Stars: 3
• Watchers: 1
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Steam OpenID Node.JS API

## Install

```

npm install --save openid-steam

```

## Usage

```js

import Steam from "openid-steam"

// Pass return URL as an argument, the URL you want Steam to return

// user to where you will parse query parameters and extract steam ID

const steam = new Steam("http://localhost:3333/auth")

steam.url()

  .then((url) => {

    // Redirect user to this url

    console.log(url)

  })

  .catch((error) => {

    console.log(error.message)

  })

// Then user will be returned to a similar URL as below:

const url = window.location.href

// Which you can verify in order to identify the user

steam.verify(url)

  .then((steamId) => {

    console.log(steamId)

  })

  .catch((err) => {

    console.log(err.message)

  })

```

## Development

- `npm run clean` - Remove `lib/` directory

- `npm test` - Run tests with linting and coverage results.

- `npm test:only` - Run tests without linting or coverage.

- `npm test:watch` - You can even re-run tests on file changes!

- `npm test:prod` - Run tests with minified code.

- `npm run test:examples` - Test written examples on pure JS for better understanding module usage.

- `npm run lint` - Run ESlint with airbnb-config

- `npm run cover` - Get coverage report for your code.

- `npm run build` - Babel will transpile ES6 => ES5 and minify the code.

- `npm run prepublish` - Hook for npm. Do all the checks before publishing your module.

# License

Released under [MIT license][]

[mit license]: http://sergey.mit-license.org/