Table of contents

• Installation
• Features
• Usage
• Contributing
• Bugs and feature requests
• Versioning
• Creators
• Thanks
• Copyright and license

Installation

The system can be installed using the npm install command:

npm install reactjs-oauth

Features

• GitHub OAuth2 Authentication

Usage

Import Component

import GitHubOAuth from "reactjs-oauth";

Handeling Functions

 // Handle a successful oauth request
 oauthGitHubSuccess = (response) => {
    console.log(response);
 };
  
 // Handle a failed oauth request
 oauthGitHubFailure = (response) => {
   console.log(response);
 };

Render Component

<GitHubOAuth
  authorizationUrl={YourAuthUrl}
  clientId={YourClienId}
  clientSecret={YourClientSecret}
  redirectUri={YourRedirectUri}
  onSuccess={this.oauthGitHubSuccess}
  onFailure={this.oauthGitHubFailure}
/>

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

All code should conform to the Code Guide, maintained by SNEK.

Bugs and feature requests

Do you have a bug or a feature request? Please first search for existing and closed issues. If your problem or idea has not been addressed yet, please open a new issue.

Versioning

For reasons of transparency concering our release cycle and in striving to maintain backward compatibility, this repository is maintained under the Semantic Versioning guidelines. Some minor screw ups aside, we try to adhere to those rules whenever possible.

Creators

Thanks

We do not have any external contributors yet, but if you want your name to be here, feel free to contribute to our project.

Copyright and license

SPDX-License-Identifier: (EUPL-1.2) Copyright © 2019-2020 Simon Prast