@evolplus/evo-passport

evo-passport

evo-passport is a versatile TypeScript/JavaScript module tailored to facilitate the development of login features by seamlessly integrating with OAuth2 providers. With this module, developers can effortlessly allow users to log in, create accounts, and manage their sessions.

Features

• Seamless OAuth Integration: Quickly integrate with popular OAuth providers like Google, Facebook, and Strava.
• Session Management: Efficiently handle user sessions with support for MySQL storage.
• User Account Handling: Manage user accounts, retrieve user data, and more.
• Express Middleware: Comes with built-in Express middleware for ease of integration in web applications.
• MySQL Provider: Built-in support for storing and retrieving user and session data from a MySQL database.
• Redis Provider: Built-in support for storing and retrieving user and session data from a Redis storage.

Getting Started

Integrate evo-passport in your project and configure it based on your application and OAuth provider details.

import express from 'express';
import * as passport from 'evo-passport';

let app = express(),
    webConfig = {
        passportHost: "localhost",
        domain: "localhost",
        prefix: "/auth";
    };
// ... Setup and use the module's functionalities
passport.setup(app, new passport.PassportModel(new passport.MySqlPassportProvider{/*MySql configuration here*/}), webConfig, ["google", "facebook"], {"google": true, "facebook": true}, async (provider, token, userInfo, req, res) => {
    // ... Process when user signed in successfully here
});

or you can use Redis as the storage instead of MySql:

passport.setup(app, new passport.PassportModel(new passport.RedisPassportProvider{/*Redis configuration here*/}), webConfig, ["google", "facebook"], {"google": true, "facebook": true}, async (provider, token, userInfo, req, res) => {
    // ... Process when user signed in successfully here
});

For detailed documentation on each component, please delve into the respective files.

License

MIT