Skip to content

Commit 9a8777b

Browse files
committed
secure-auth-api-v1
1 parent 1f88cd3 commit 9a8777b

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
A **secure authentication API** using **Node.js, Express, JWT, Google OAuth2, and Two-Factor Authentication (2FA)**.
44

55
## 🚀 Features
6-
**User Authentication** (Register, Login, Logout)
6+
**User Authentication** (Register, Login)
77
**Google OAuth 2.0 Login**
88
**JWT Token Authentication**
9-
**Two-Factor Authentication (2FA)** with OTP
9+
**Two-Factor Authentication (2FA)** with OTP & QR Code
1010
**Secure Routes** for logged-in users
1111
**Password Hashing with bcrypt**
1212
**Proper Error Handling & Security Measures**
@@ -52,7 +52,7 @@ GOOGLE_CLIENT_ID=your_google_client_id
5252
GOOGLE_CLIENT_SECRET=your_google_client_secret
5353
EMAIL_SERVICE=email_service_for_2fa
5454
EMAIL_USER=your_email
55-
EMAIL_PASS=your_email_password
55+
EMAIL_PASS=your_email_password (App Password)
5656
```
5757

5858
### 4️⃣ Start the Server
@@ -70,7 +70,6 @@ npm run dev
7070
|--------|----------------------|-----------------------------|
7171
| POST | `/api/auth/register` | Register a new user |
7272
| POST | `/api/auth/login` | Login and get JWT token |
73-
| GET | `/api/auth/logout` | Logout user |
7473

7574
### **Google Authentication**
7675
| Method | Endpoint | Description |
@@ -81,7 +80,7 @@ npm run dev
8180
### **Protected Routes (JWT Required)**
8281
| Method | Endpoint | Description |
8382
|--------|---------------------|----------------------|
84-
| GET | `/api/protected` | Test Protected Route |
83+
| GET | `/api/profile` | Test Protected Route |
8584

8685
---
8786

@@ -94,8 +93,15 @@ npm run dev
9493

9594
---
9695

96+
## 🏗 About the Development
97+
This project serves as a **pre-built secure authentication template** for developers seeking a hassle-free and **ready-to-use** authentication system. It eliminates the need to worry about security concerns, token management, or OAuth integration, allowing developers to **focus on building their application** rather than spending time on authentication implementation.
98+
99+
This template is designed to be **scalable, secure, and easy to integrate**, making it the perfect choice for projects requiring a strong authentication system without the complexity.
100+
101+
---
102+
97103
## 📜 License
98104
This project is licensed under the **MIT License**.
99105

100106
🔗 **Live Demo:** _Coming Soon_ 🚀
101-
💬 **Need Help?** Create an issue or reach out! 🎯
107+
💬 **Need Help?** Create an issue or reach out! 🎯

0 commit comments

Comments
 (0)