Skip to content

Latest commit

 

History

History
139 lines (93 loc) · 4.15 KB

README.md

File metadata and controls

139 lines (93 loc) · 4.15 KB

Banner

🔒 MERN-Auth

This repository features a MERN stack authentication system, encompassing user registration, login, and JWT-based session management. It securely handles passwords and token cookies, making it an excellent foundation for building secure and scalable web applications.

🔗 Website Link: Live

📚 Table of Contents

🔧 Technologies Used

  • Frontend: React JS ⚛️
  • Backend: Express JS 🐍
  • Database: MongoDB 🗄️
  • Authentication: JWT (JSON Web Tokens) 🔐
  • Email Service: Mailtrap 📫

✨ Features

  • 🔒 User Authentication: Comprehensive authentication system including sign-up, login, sign-out, and JWT-based session management.
  • ✉️ Email Verification: Integrated Mailtrap for managing email verification and password reset workflows.
  • 🔑 Password Management: Secure handling of forgot password, reset password, and reset verification workflows.
  • 📝 CRUD Operations: Create, Read, Update, and Delete operations for user and application data.
  • 📱 Responsive UI: Developed using React components, ensuring a seamless experience across devices.
  • 📡 API: Robust API constructed using Express.js and MongoDB for seamless data interaction.

📖 Setup Instructions

🛠️ Backend (Express JS)

  1. Clone the repository:

    git clone https://github.com/Fingertips18/mern-auth.git

  2. Install dependencies:

    npm install

  3. Set up environment variables. Create a .env file in the root directory::

    PORT=<PORT>
MONGO_URI=<MONGO_URI>
JWT_SECRET=<JWT_SECRET>
NODE_ENV=<NODE_ENV>
EMAILJS_SERVICE_ID=<EMAILJS_SERVICE_ID>
EMAILJS_TEMPLATE_ID=<EMAILJS_TEMPLATE_ID>
EMAILJS_PUBLIC_KEY=<EMAILJS_PUBLIC_KEY>
EMAILJS_PRIVATE_KEY=<EMAILJS_PRIVATE_KEY>
CLIENT_URL=<CLIENT_URL>

  4. Run the backend server:

    npm run dev

⚛️ Frontend (React JS)

  1. Navigate to the frontend directory:

    cd frontend

  2. Install dependencies:

    npm install

  3. Set up environment variables. Create a .env.local file in the frontend directory:

    VITE_BASE_URL=<VITE_BASE_URL>

  4. Run the frontend server:

    npm run dev

📡 API Endpoints

  • Root:

    • GET /: The root of the server

  • Authentication:

    • POST /api/auth/sign-up : Register a new user.

    • POST /api/auth/sign-in : Log in a user and return a JWT.

    • POST /api/auth/sign-out : Log out a user and clear the session.

    • POST /api/auth/verify-email : Verify a user's email address.

    • POST /api/auth/forgot-password : Send a password reset email.

    • POST /api/auth/reset-password : Reset a user's password.

    • GET /api/auth/verify-token : Verify the validity of a JWT.

🔒 Authentication

This project uses JWT for secure authentication. Tokens are stored in cookies with HttpOnly and SameSite attributes for enhanced security. Both the frontend and backend handle the verification and expiration of the token.

🤝 Contributing

Feel free to fork this repository and contribute by submitting a pull request. All contributions are welcome!

🧑‍💻 Contributors

Ghian Tan @ Fingertips (Github)

📜 License

This project is licensed under the MIT License.