Easy-auth

This npm package provides functionalities for user registration, OTP verification, user login, token verification, and user logout using Express.js and Mongoose for MongoDB integration.

Installation

To use easy-auth, make sure to install the following peer dependencies in your project:

• cookie-parser
• dotenv
• express
• jsonwebtoken
• mongoose
• nodemailer

You can install them using:

npm install cookie-parser dotenv express jsonwebtoken mongoose nodemailer 

After installing the peer dependencies, you can then install and use easy-auth in your project.

npm install Easy-auth

Import

import this package to make your node auth easy

const { Register, VerifyOtp ,Login,TokenVerification,Logout,ResendOtp} = require('easy-auth');

Usage

Setting Up Express Server First, import necessary modules and set up your Express server:

const express = require('express');
const mongoose = require('mongoose');
const cookieParser = require('cookie-parser');
const { Register, VerifyOtp, Login, TokenVerification, Logout, ResendOtp } = require('easy-auth');

const app = express();

app.use(cookieParser());
app.use(express.json());

// Connect to MongoDB
const dbtoken = process.env.MONGODBURL;
mongoose.connect(dbtoken).then(() => {
  console.log('MongoDB connected');
}).catch((err) => {
  console.error('MongoDB connection error:', err);
});

// Start the server
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server is running on port ${PORT}`);
});

Verifying OTP

Verify OTP (one-time password) for user authentication with a POST request to /verify-otp:

app.get('//verify-otp',(req,res)=>{
  VerifyOtp(req,res).then((e)=>{
      res.json({otp:e})
      }).catch((err)=>{
      res.json({otp:err})
  })
})

Re-Send OTP

Verify OTP (one-time password) for user authentication with a POST request to /verify-otp:

app.get('/resendotp', (req, res) => {

  ResendOtp(req,res).then(()=>{
    res.json({ status:true,msg: 'otp sent' });
  }).catch((err)=>{
    res.json({ status:true,msg: `otp sent${err}` });
  })

  
});

User Login

Authenticate a user by sending a POST request to /login:

app.post('/login', (req, res) => {
  Login(req, res)
    .then((user) => {
      res.json({ message: 'Login successful', user });
    })
    .catch((err) => {
      console.error('Login error:', err);
      res.status(401).json({ error: 'Login failed' });
    });
});

Protected Routes with Token Verification

Access protected routes by sending a GET request to /protected-route. This route requires token verification using the tokenVerification middleware:

app.get('/protected-route', tokenVerification, (req, res) => {
  // Access user data from decoded token in req.user
  res.json({ message: 'Protected route accessed successfully', user: req.user });
});

User Logout

Log out a user by sending a GET request to /logout:

app.get('/logout', Logout, (req, res) => {
  res.json({ message: 'User logged out successfully' });
});

.env

Add these variable in your environment file

EMAILPASSWORD=your-gmail-sskey
EMAIL=your-email-from-which-you-want-to-send-mail
SECRECTKEY=json-web-token-secrect-key
MONGODBURL =Your-Mongodb-Url