comfytwitch
v1.0.7
Published
Comfiest Way to Add Serverless Twitch Authentication
Downloads
23
Maintainers
instafluffReadme
ComfyTwitch
Comfiest Way to Add Serverless Twitch Authentication
ComfyTwitch lets you integrate Twitch authentication for websites without a server SUPER EASILY in just a few lines of code. It automatically caches the authentication in the browser so that users do not have to log in every single visit.
Instafluff
Like these projects? The best way to support my open-source projects is by becoming a Comfy Sponsor on GitHub!
https://github.com/sponsors/instafluff
Come and hang out with us at the Comfiest Corner on Twitch!
https://twitch.tv/instafluff
Demo
To see how it works, check out this static webpage that authenticates using Twitch OAuth: https://www.instafluff.tv/ComfyTwitch
Instructions
Prequisites
Create a Twitch application from https://dev.twitch.tv/console/apps/create to generate a Twitch Client ID
Add an OAuth Redirect URL to your Twitch application for the authentication to redirect the user to afterwards. A local example would look like:
http://localhost:8800/index.html
Website
- Download
comfytwitch.min.jsfrom thewebfolder or include from the JSDeliver CDN and add into every page you need authenticated:
<script src="comfytwitch.min.js"></script>OR
<script src="https://cdn.jsdelivr.net/npm/comfytwitch@latest/web/comfytwitch.min.js"></script>- Check for Twitch authentication using
ComfyTwitch.Check()for whether or not the user is logged in. The authentication is cached in the browser so that the user does not have to log in every time.
<html>
<head>
<script src="https://cdn.jsdelivr.net/npm/comfytwitch@latest/web/comfytwitch.min.js"></script>
</head>
<body>
<script type="text/javascript">
const clientId = "YOUR-CLIENT-ID";
const baseUrl = window.location.origin;
ComfyTwitch.Check()
.then( result => {
if( result ) {
// Logged In
}
else {
// Logged Out
}
});
</script>
</body>
</html>- Add Twitch Log-In by calling
ComfyTwitch.Login()on a button click or through a separate page, passing in the Client ID, the same Redirect URI as set in your Twitch application, and the Twitch Permission Scopes you need:
ComfyTwitch.Login( "YOUR-CLIENT-ID", `http://localhost:8800/index.html`, [ "user:read:email" ] );- Add Twitch Log-out by calling
ComfyTwitch.Logout()
Additional Functions
- GetUser
( clientId, userId )- Retrieve a Twitch user's information
let user = await ComfyTwitch.GetUser( "YOUR-CLIENT-ID", "TWITCH-USER-ID" );