implement google oauth, built user model

Author: SecretariatV

.env.example

@@ -1,2 +1,9 @@
 PORT=
-MONGO_URI=
+MONGO_URI=
+SECRET=
+JWT_SECRET=
+GOOGLE_CLIENT_ID=
+GOOGLE_CLIENT_SECRETE=
+GOOGLE_CALLBACK_URL=
+FRONTEND_URL=
+BACKEND_URL=

README.md

@@ -15,7 +15,7 @@ A comprehensive and professional Node.js backend boilerplate designed for buildi
 3. [To-Do List](#to-do-list)
 4. [Getting Started](#getting-started)
 5. [Project Structure](#project-structure)
-6. [Usage](#usage)
+6. [Authentication Setup](#authentication-setup)
 7. [Code Quality Automation](#code-quality-automation)
 8. [Configuration](#configuration)
 9. [Testing](#testing)
@@ -146,12 +146,41 @@ node-backend-boilerplate/
 
 ---
 
-## **Usage**
+## **Authentication Setup**
 
 ### **Google Authentication**
 
+1. **Set Up Google OAuth2 application**
+
+- Go to the [Google Cloud Console](https://console.cloud.google.com/).
+- Create a new project and enable the "OAuth2.0 API".
+- Set up an OAuth consent screen and create credentials for a Web Application.
+- Add authorized redirect URIs (e.g., `http://localhost:5000/auth/google/callback`).
+
+2. **Environment Variables**
+   Update your `.env` file with the following variables:
+
+   ```plaintext
+   GOOGLE_CLIENT_ID=<Your Google Client ID>
+   GOOGLE_CLIENT_SECRET=<Your Google Client Secret>
+   GOOGLE_CALLBACK_URL=http://localhost:5000/auth/google/callback
+   ```
+
 ### **Phone Code Authentication**
 
+1. **Set Up Twilio Account**
+
+- Go to the [Twilio Console](https://www.twilio.com).
+- Create a Messaging Service and note the SID.
+
+2. **Environment Variables**
+   Update your `.env` file with the following variables:
+   ```plaintext
+   TWILIO_ACCOUNT_SID=<Your Twilio Account SID>
+   TWILIO_AUTH_TOKEN=<Your Twilio Auth Token>
+   TWILIO_PHONE_NUMBER=<Your Twilio Phone Number>
+   ```
+
 ---
 
 ## **Code Quality Automation**

eslint.config.mjs

@@ -11,6 +11,8 @@ export default [
     files: ['**/*.{js,mjs,cjs,ts}'],
     rules: {
       'no-console': 'warn',
+      '@typescript-eslint/no-namespace': 'off',
+      '@typescript-eslint/no-empty-object-type': 'off',
     },
   },
 ];

package.json

@@ -26,7 +26,15 @@
   "license": "MIT",
   "devDependencies": {
     "@eslint/js": "^9.15.0",
+    "@types/bcryptjs": "^2.4.6",
+    "@types/cookie-parser": "^1.4.7",
+    "@types/cors": "^2.8.17",
     "@types/express": "^5.0.0",
+    "@types/express-session": "^1.18.0",
+    "@types/jsonwebtoken": "^9.0.7",
+    "@types/passport": "^1.0.17",
+    "@types/passport-google-oauth20": "^2.0.16",
+    "@types/passport-local": "^1.0.38",
     "@types/supertest": "^6.0.2",
     "@types/swagger-jsdoc": "^6.0.4",
     "@types/swagger-ui-express": "^4.1.7",
@@ -42,9 +50,17 @@
     "winston": "^3.17.0"
   },
   "dependencies": {
+    "bcryptjs": "^2.4.3",
+    "cookie-parser": "^1.4.7",
+    "cors": "^2.8.5",
     "dotenv": "^16.4.5",
     "express": "^4.21.1",
+    "express-session": "^1.18.1",
+    "jsonwebtoken": "^9.0.2",
     "mongoose": "^8.8.2",
+    "passport": "^0.7.0",
+    "passport-google-oauth20": "^2.0.0",
+    "passport-local": "^1.0.0",
     "swagger-jsdoc": "^6.2.8",
     "swagger-ui-express": "^5.0.1",
     "ts-node": "^10.9.2"