Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neelakandanv/password-reset-be
Password Reset is designed to help the users to reset their password with Email
https://github.com/neelakandanv/password-reset-be
bcryptjs corsair-rgb dotenv expressjs javascript jwt mongodb mongoose nodejs nodemailer nodemon validator
Last synced: about 1 month ago
JSON representation
Password Reset is designed to help the users to reset their password with Email
- Host: GitHub
- URL: https://github.com/neelakandanv/password-reset-be
- Owner: NeelakandanV
- Created: 2024-07-21T11:30:46.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-07-24T07:44:53.000Z (5 months ago)
- Last Synced: 2024-08-23T02:19:24.204Z (4 months ago)
- Topics: bcryptjs, corsair-rgb, dotenv, expressjs, javascript, jwt, mongodb, mongoose, nodejs, nodemailer, nodemon, validator
- Language: JavaScript
- Homepage: https://passwordreset-bb6e.onrender.com
- Size: 18.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Password Reset Flow
### This documentaion provides details about the Password Reset workflow, implemented using Node.js and Express. This API allows you to manage user SignUp , Login , Forgot Password , Reset Password and Delete calls.
## URL - https://passwordreset-bb6e.onrender.com ##
## Features :-
### bcryptjs - For Password hashing,your data is safe and secure.
### JWT - For Authorization in our website.
### Note: Since I'm deployed the apis in render's free tier, The initial request is taking time, Please wait little longer for initial request
# API Endpoints:-
## Login
### https://passwordreset-bb6e.onrender.com/ - POST method
Description : This method check whether the user with given EmailId and Password exists.If exists means it will allow the users to Login,else not.
## Signup
### https://passwordreset-bb6e.onrender.com/Signup - POST method
Description : This method will allow new users to register if Email Id not registered already.
## Displays Users
### https://passwordreset-bb6e.onrender.com/Dashboard - GET method
Description : This method displays users list to users who are logged in.Users will be logged out after a certain Time.
This will be done with the help of **JsonWebToken**
## Delete User
### https://passwordreset-bb6e.onrender.com/delete/:id - DELETE method
Description : This method enables users to delete their account (**give Email as id**)
## Forgot Password
### https://passwordreset-bb6e.onrender.com/ForgotPassword - PUT method
Description : This method generates a random string and stores in database for later verification,if the user exists
It allows sends email with reset link(Using ***Nodemailer***) for the verified user
## Reset Password link
### https://passwordreset-bb6e.onrender.com/ResetPassword/:id/:pin/:token - GET method
Description : This method verifies the random string in database and the link are same.Also verifies the **JsonWebToken** for the link validity.
This link is valid for 5mins which will allow users to reset password only in that stipulated time.
**( id - user Id , pin - randomly generated , token - JWT)**
## Reset Password
### https://passwordreset-bb6e.onrender.com/ResetPassword/:id/:pin/:token - PUT method
Description : After the verification is done in GET method.It will allow users to reset their Pasword and the same will be uploaded in database after deleting the randomly generated string which is used for verification purpose.
**( id - user Id , pin - randomly generated , token - JWT)**