Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fingertips18/mern-auth
A MERN stack authentication system that includes user registration, login, and JWT-based session management with secure handling of passwords and token cookies. Ideal for building secure, scalable web applications.
https://github.com/fingertips18/mern-auth
authentication express-js javascript jwt-authentication mailtrap mern-stack reactjs signin signup
Last synced: about 1 month ago
JSON representation
A MERN stack authentication system that includes user registration, login, and JWT-based session management with secure handling of passwords and token cookies. Ideal for building secure, scalable web applications.
- Host: GitHub
- URL: https://github.com/fingertips18/mern-auth
- Owner: Fingertips18
- License: mit
- Created: 2024-08-28T06:06:33.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-11-02T20:28:04.000Z (about 2 months ago)
- Last Synced: 2024-11-02T21:22:07.585Z (about 2 months ago)
- Topics: authentication, express-js, javascript, jwt-authentication, mailtrap, mern-stack, reactjs, signin, signup
- Language: JavaScript
- Homepage: https://mern-auth-tau7.onrender.com
- Size: 1.01 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🔒 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](https://mern-auth-tau7.onrender.com)
## 📚 Table of Contents
- 🔧 [Technologies Used](#tech-used)
- ✨ [Features](#features)
- 📖 [Setup Instructions](#setup)
- 🐍 [Backend (Express JS)](#backend)
- ⚛️ [Frontend (React JS)](#frontend)
- 📡 [API Endpoints](#api)
- 🔒 [Authentication](#auth)
- 🤝 [Contributing](#contributing)
- 📜 [License](#license)
## 🔧 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**:
```bash
git clone https://github.com/Fingertips18/mern-auth.git
```
2. **Install dependencies**:
```bash
npm install
```
3. **Set up environment variables. Create a `.env` file in the root directory:**:
```dotenv
PORT=
MONGO_URI=
JWT_SECRET=
NODE_ENV=
EMAILJS_SERVICE_ID=
EMAILJS_TEMPLATE_ID=
EMAILJS_PUBLIC_KEY=
EMAILJS_PRIVATE_KEY=
CLIENT_URL=
```
4. **Run the backend server**:
```bash
npm run dev
```
### ⚛️ Frontend (React JS)
1. **Navigate to the frontend directory**:
```bash
cd frontend
```
2. **Install dependencies**:
```bash
npm install
```
3. **Set up environment variables. Create a `.env.local` file in the frontend directory**:
```dotenv
VITE_BASE_URL=
```
4. **Run the frontend server**:
```bash
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](https://github.com/Fingertips18))
## 📜 License
This project is licensed under the MIT License.