https://github.com/achrefdevtn/jwt-auth-starter
A Node.js and Express application showcasing JWT authentication with MySQL. Includes secure user registration, login, token-based protection for routes, and centralized error handling with Winston. Perfect for learning and implementing JWT in a real-world setting.
https://github.com/achrefdevtn/jwt-auth-starter
api-security authentication expressjs jwt mysql nodejs
Last synced: 28 days ago
JSON representation
A Node.js and Express application showcasing JWT authentication with MySQL. Includes secure user registration, login, token-based protection for routes, and centralized error handling with Winston. Perfect for learning and implementing JWT in a real-world setting.
- Host: GitHub
- URL: https://github.com/achrefdevtn/jwt-auth-starter
- Owner: AchrefDevTN
- License: mit
- Created: 2024-08-20T10:37:23.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-08T00:41:51.000Z (over 1 year ago)
- Last Synced: 2025-03-17T18:18:20.677Z (11 months ago)
- Topics: api-security, authentication, expressjs, jwt, mysql, nodejs
- Language: JavaScript
- Homepage:
- Size: 41 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JWT Authentication Starter
## Overview
This repository provides a comprehensive implementation of JWT authentication using Node.js, Express, and MySQL. The project showcases best practices in user registration, login, token-based authentication, and protected routes, all while maintaining robust error handling and logging mechanisms.
## Table of Contents
- [Features](#features)
- [Tech Stack](#tech-stack)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [API Endpoints](#api-endpoints)
- [Error Handling](#error-handling)
- [Logging](#logging)
- [Contributing](#contributing)
- [License](#license)
- [Links](#-links)
## Features
- **User Registration**: Secure user registration with bcrypt password hashing.
- **User Login**: JWT token generation for authenticated users.
- **Protected Routes**: Middleware-enforced JWT protection for sensitive routes.
- **Error Handling**: Centralized error management with detailed logging using Winston.
## Tech Stack
- **Backend**: Node.js, Express
- **Database**: MySQL
- **Authentication**: JWT (JSON Web Tokens)
- **Logging**: Winston
- **Environment Management**: dotenv
## Prerequisites
Ensure you have the following installed and configured on your machine:
- **Node.js**: Version 14 or higher. [Download here](https://nodejs.org/).
- **MySQL**: MySQL server or a compatible database. [Download here](https://dev.mysql.com/downloads/mysql/).
For installation assistance, refer to the official documentation or guides.
## Setup
1. **Clone the repository:**
```bash
git clone https://github.com/AchrefDevTN/jwt-auth-starter.git
```
2. **Navigate into the project directory:**
```bash
cd jwt-auth-starter
```
3. **Install dependencies:**
```bash
npm install
```
4. **Create a .env file in the root directory:**
(Copy the contents below and configure your environment variables)
```ini
PORT=5000
JWT_SECRET=your_jwt_secret
JWT_EXPIRATION=1h
DB_USERNAME=root
DB_PASSWORD=your_db_password
DB_NAME=jwt_auth_db
DB_HOST=localhost
```
5. **Run the application:**
- For development
```bash
npm run dev
```
- For production
```bash
npm start
```
6. **Access the API:**
- The server will be running on
```bash
http://localhost:5000
```
## API Endpoints
- **POST `/api/auth/register`**
Registers a new user.
**Request body:**
```json
{
"username": "string",
"password": "string"
}
```
**Response:**
```json
{
"message": "User registered successfully"
}
```
- **POST `/api/auth/login`**
Logs in a user and returns a JWT token.
**Request body:**
```json
{
"username": "string",
"password": "string"
}
```
**Response:**
```json
{
"token": "jwt_token_string"
}
```
- **GET `/api/auth/protected`**
Access a protected route (JWT required in the Authorization header).
**Response:**
```json
{
"message": "This is a protected route",
"userId": "user_id"
}
```
## Error Handling
Errors are handled centrally in the middleware. If an error occurs, the server responds with an appropriate status code and message. All errors are logged using Winston for debugging and monitoring purposes.
## Logging
The application uses Winston for logging. Logs are written to both the console and a file named app.log.
## Contributing
If you have suggestions or improvements, please submit an issue or pull request. Contributions are welcome!
## License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/AchrefDevTN/jwt-auth-starter/blob/main/LICENSE) file for details.
## 🔗 Links
[]([https://www.linkedin.com/](https://www.linkedin.com/in/achref-ben-brahim-dev/))
| Node.js | Express | MySQL | License |
|---------|---------|-------|---------|
| [](https://nodejs.org/) | [](https://expressjs.com/) | [](https://www.mysql.com/) | [](https://github.com/AchrefDevTN/jwt-auth-starter/blob/main/LICENSE) |