Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 2.43 KB

README.md

File metadata and controls

45 lines (34 loc) · 2.43 KB

Email Armor

Github Stars Licence Downloads npm version Size Twitter Follow

Size

What is Email Armor?

Email Armor is a powerful npm module designed for Node.js and Next.js, providing a secure and flexible authentication system with built-in two-step verification via Nodemailer (using GMAIL). The package also includes a robust referral system to encourage user engagement and growth. Currently, it supports MongoDB as the only database.

For a quick start, please refer to the documentation. Additionally, check out this SDK, where Email Armor is seamlessly integrated with Next.js 14. You can clone the repository to jump-start your project with a pre-configured environment.

Features In v1:

  • ✅ Next.js & Node.js compatibility
  • ✅ Customizable mail templates (dynamic content)
  • ✅ Resend OTP with rate limiting
  • ✅ Reset password with two-step verification
  • ✅ Local and server-side session validation
  • ✅ Built-in referral system
  • ✅ Referral history tracking

Upcoming Features

  • ❌ Sign-in with two-step verification
  • ❌ Profile picture management (add/remove)
  • ❌ Change email and password functionality
  • ❌ Account lock after multiple failed login attempts with email notification
  • ❌ Unlock user account (manual/automatic options)