forgetpasses

ForgetPasses

The securest passwordless authentication system
Explore the docs »

View Demo · Report Bug · Homepage

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage

About The Project

There are many great authentication systems for nodejs. But forgetpasses provides a passwordless authentication system with 3D Security layers to provide the best security for your web application and your users.

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• [![Next][Next.js]][Next-url]
• [![React][React.js]][React-url]

Getting Started

To use forgetpasses you have to create a service account here
After that you have to install the npm package with:

Prerequisites

Installation

1. Install NPM packages

   npm install forgetpasses

2. Get a free API Key at https://forgetpasses.com/dashboard/settings
3. Require forgetpasses with your api key config.js

   const forgetpasses = require("forgetpasses")';
   var fp = new forgetpasses("YOUR_API_KEY")';

Usage

Validate Your API-Token

app.get('/', async (req, res) => {
   //Returns true if token is valid, 
   //Returns false if token is invalid
   data = await fp.checkToken(req);
   res.send(data)
});

Generate a LoginSession

app.get('/generateLoginSession', async (req, res) => {
 //User gets redirected to google after succesfull logged in
 data = await fp.generateLoginSession(req,res, "https://google.com");
 //Retrieve all data
 res.send(data)
});

Check if User is Loggedin

//True or false if client is logged in
app.get('/checkIfClientIsLoggedIn', async (req, res) => {
 data = await fp.checkStatus(req);
 res.send(data)
});

Get User Data

//True or false if client is logged in
app.get('/getData', async (req, res) => {
 data = await fp.getUserData(req);
 res.send(data)
});

For more examples, please refer to the Documentation

Roadmap

• [x] Add Changelog
• [ ] Add Additional Templates w/ Examples
• [ ] Update Service Dashboard
• [ ] Multi-language Support
  • [ ] German

License

Distributed under the MIT License

Contact

Your Name - @forgetpasses - [e-mail]

Project Link: https://github.com/forgetpasses/forgetpasses