Skip to content

Commit

Permalink
docs: demo readme
Browse files Browse the repository at this point in the history
Signed-off-by: Vaibhav Upreti <[email protected]>
  • Loading branch information
VaibhavUpreti committed Dec 31, 2024
1 parent 635e2e9 commit 45a0863
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 21 deletions.
2 changes: 2 additions & 0 deletions GRANTS.MD
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@ It supports the following [grant types](https://oauth.net/2/grant-types/) out of

### Authorization Code Flow


### Authorization Code Flow with PKCE



### Refresh Token

**Important:** Do not refresh tokens unless you have implemented a refresh token rotation mechanism.
Expand Down
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,27 @@
[![CI](https://github.com/VaibhavUpreti/authkeeper/actions/workflows/nodejs.yml/badge.svg)](https://github.com/VaibhavUpreti/authkeeper/actions/workflows/nodejs.yml)
[![Dependabot](https://img.shields.io/badge/dependabot-enabled-success.svg)](https://dependabot.com)

authkeeper is a lightweight JavaScript ES6 module(51.7 kB) for implementing OAuth 2.0 clients in web, desktop, and mobile applications.
authkeeper is a lightweight JavaScript ES6 module (51.7 kB) for implementing OAuth 2.0 clients in web, desktop, and mobile applications. authkeeper is designed to work seamlessly in both **browser-based** and **server-side (Node.js)** environments.

It is inspired by the Doorkeeper gem in Ruby, which is widely used for OAuth 2.0 authorization in Ruby on Rails applications. authkeeper provides an easy-to-use API for OAuth 2.0 authentication flows.

Supported features:

- [The OAuth 2.0 Authorization Framework](https://datatracker.ietf.org/doc/html/rfc6749)
- [Authorization Code Flow](https://datatracker.ietf.org/doc/html/rfc6749#section-4.1)
- [Access Token Scopes](https://datatracker.ietf.org/doc/html/rfc6749#section-3.3)
- [Refresh token](https://datatracker.ietf.org/doc/html/rfc6749#section-1.5)
- [OAuth 2.0 for Native Apps](https://datatracker.ietf.org/doc/html/rfc8252)
- [Proof Key for Code Exchange by OAuth Public Clients](https://datatracker.ietf.org/doc/html/rfc7636)

<!-- - [Implicit grant](https://datatracker.ietf.org/doc/html/rfc6749#section-4.2)
<!-- - [Resource Owner Password Credentials](https://datatracker.ietf.org/doc/html/rfc6749#section-4.3) -->
<!-- - [Client Credentials](https://datatracker.ietf.org/doc/html/rfc6749#section-4.4) -->
<!-- - [OAuth 2.0 Token Revocation](https://datatracker.ietf.org/doc/html/rfc7009)
- [OAuth 2.0 Token Introspection](https://datatracker.ietf.org/doc/html/rfc7662) -->
<!-- - [OAuth 2.0 Threat Model and Security Considerations](https://datatracker.ietf.org/doc/html/rfc6819)
- [OAuth 2.0 for Native Apps](https://datatracker.ietf.org/doc/html/rfc8252)
- [Proof Key for Code Exchange by OAuth Public Clients](https://datatracker.ietf.org/doc/html/rfc7636) -->
-->

## Usage

Expand Down Expand Up @@ -145,7 +150,7 @@ const userData = await oauthClient.getUserInfo(accessToken);
```


## Grant types
## Supported OAuth Grant types

For more information look [GRANTS.md](./GRANTS.md)

Expand All @@ -155,7 +160,7 @@ These applications show how authkeeper works and how to integrate with it. Start


1. [SSR application](./demo/ssr-express-demo/README.md)
2. [React SPA](./demo/react-spa-demo/README.md) https://authkeeper-spa.vaibhavupreti.me/
2. [React SPA](./demo/react-spa-demo/README.md) - https://authkeeper-spa.vaibhavupreti.me/
3. [Native Mobile Apps/ browser based spa](./demo/browser-spa/README.md)

## License
Expand Down
23 changes: 7 additions & 16 deletions demo/README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,20 @@


# Demo
# Using authkeeper with various clients


### Browser based/Native apps

[refer](./browser-spa/README.md)

https://github.com/user-attachments/assets/1d98e4a7-930f-42ef-a6cd-7e20c6f15039



### SSR apps

[Refer](./ssr-express-demo/README.md)
https://github.com/user-attachments/assets/67de8d11-503b-41f1-ad49-e08f9622eb52


### SSR apps

[refer](./ssr-express-demo/README.md)


https://github.com/user-attachments/assets/1d98e4a7-930f-42ef-a6cd-7e20c6f15039

### React SPA Demo

Expand All @@ -28,11 +24,6 @@ https://github.com/user-attachments/assets/67de8d11-503b-41f1-ad49-e08f9622eb52

https://authkeeper-spa.vaibhavupreti.me/

[code](./ssr-demo)





https://github.com/user-attachments/assets/2eff0c93-e800-4356-a37f-be6ba721fa96
[refer](./ssr-demo)

https://github.com/user-attachments/assets/2eff0c93-e800-4356-a37f-be6ba721fa96

0 comments on commit 45a0863

Please sign in to comment.