Skip to content

Authentication Guide

Introduction

This documentation covers the authentication system for the project. Users can either create an account using their email and password or log in using their social media accounts like Facebook or Google.

Authentication Overview

Our system supports the following authentication methods: - Email/Password Login - Social Login (Google/Facebook)

Account Creation/Sign Up

Register

To start using the application, users need to create an account.

Required Information:

  • Name
  • Email (Valid email address)
  • Password (Must be at least 8 characters)

How to Register:

  1. Navigate to the registration page.
  2. Enter your name, email, and password.
  3. Click on the "Register" button.

Password Rules:

  • The password must be at least 8 characters long.
  • It should include a mix of letters, numbers, and optionally symbols to ensure strong security.

Email/Password Login

Once your account is created, you can log in using your email and password.

How to Log In:

  1. Navigate to the login page.
  2. Enter your registered email and password.
  3. If the credentials are correct, you will be redirected to the dashboard.

Forgot Password

Forgot Password

If you've forgotten your password, you can reset it using the following steps:

Steps to Reset Your Password:

  1. Click on "Forgot Password?"

  2. On the login page, you'll find the "Forgot Password?" link below the login form. Click on this link to begin the password recovery process.

  3. Enter Your Email

  4. After clicking "Forgot Password?", you will be prompted to enter the email address associated with your account. Enter your email and click on the Send button.

  5. Check Your Email

  6. A password reset link will be sent to your inbox. Check your email for a message with a reset link.
    Reset Password

  7. Click on the Reset Password Button

  8. In your email inbox, click on the reset password button or the link provided.

  9. Reset Your Password

  10. You will be redirected to a new page where you can enter your new password and confirm password.

  11. The password must be at least 8 characters long.
    Reset Password

  12. Submit Your New Password

  13. After entering the new password and confirming it, click on the Submit button to complete the process.

  14. Password Reset Complete

  15. Upon successfully resetting your password, you will be automatically redirected to the dashboard, where you can log in with your new password.

Social Login

Users can also log in using their social media accounts like Google or Facebook.

Supported Platforms:

  • Google
  • Facebook

Google Login Setup

  1. Go to Google Developer Console

  2. Visit Google Developer Console and sign in with your Google account.

  3. Create a New Project

  4. Click on the "Select Project" button.
  5. Provide a Project Name and click Create. Select Project New Project
  6. Enable OAuth 2.0
  7. Navigate to API & Services > Credentials.

  8. Click "Create Credentials" > OAuth 2.0 Client IDs.

  9. Configure OAuth Consent Screen

  10. Go to the OAuth Consent Screen tab.
  11. Fill out the required fields (App Name, Logo, etc.) and save. Google OAuth Screen
  12. Set Application Type and Redirect URIs
  13. Choose Web Application as the application type.

  14. Add https://your-domain.com/login/google/callback as the Authorized Redirect URI.

  15. Copy Client ID and Secret

  16. Save the generated Client ID and Client Secret for later use.

Facebook Login Setup

  1. Go to Facebook Developer Portal

  2. Visit Facebook for Developers and sign in.

  3. Create a New App

  4. Click "Create App", select Consumer, and fill in the required details.

  5. Add Facebook Login Product

  6. In the app dashboard, click Add Product and select Facebook Login.
  7. Set Redirect URIs
  8. Go to Settings > Facebook Login and add https://your-domain.com/login/facebook/callback as a Valid OAuth Redirect URI.
  9. Copy App ID and Secret

  10. Navigate to Settings > Basic to obtain the App ID and App Secret.

  11. Make the App Live

  12. Switch your app from Development to Live mode in the dashboard.

Backend Configuration

Dynamic Client Credentials Management

To allow users to manage their social login configurations dynamically, the Google and Facebook Client IDs and Secrets will be stored and updated from the Admin Panel under Settings > General Settings.

Steps to Configure Dynamic Settings:

  1. Admin Panel Settings:
  2. Navigate to the Admin Panel.

  3. Go to Settings > General Settings.

  4. Update Google Configuration for Social Login:

  5. Enter the Google Client ID, Google Client Secret, and the Redirect URL in their respective fields.
  6. Update Facebook Configuration for Social Login:

  7. Enter the Facebook App ID, Facebook App Secret, and the Redirect URL in their respective fields.

  8. Save the Changes:

  9. Once all fields are filled, click Save to update the credentials.