https://github.com/achrefdevtn/rate-limiting
A Node.js Express app demonstrating rate limiting with the MVC architecture. Limits API requests to prevent abuse: 100 requests per 15 minutes globally, 5 login attempts per 15 minutes. Includes helmet for security. Organized into controllers, routes, and configuration.
https://github.com/achrefdevtn/rate-limiting
api-rate-limiting expressjs nodejs rate-limiting web-security
Last synced: 3 months ago
JSON representation
A Node.js Express app demonstrating rate limiting with the MVC architecture. Limits API requests to prevent abuse: 100 requests per 15 minutes globally, 5 login attempts per 15 minutes. Includes helmet for security. Organized into controllers, routes, and configuration.
- Host: GitHub
- URL: https://github.com/achrefdevtn/rate-limiting
- Owner: AchrefDevTN
- License: mit
- Created: 2024-08-20T10:50:41.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-20T12:20:32.000Z (almost 2 years ago)
- Last Synced: 2025-03-17T18:18:23.900Z (over 1 year ago)
- Topics: api-rate-limiting, expressjs, nodejs, rate-limiting, web-security
- Language: JavaScript
- Homepage:
- Size: 20.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rate Limiting
## Overview
This repository provides a comprehensive implementation of rate limiting using Node.js and Express. The project showcases best practices in applying global and route-specific rate limits to prevent abuse and ensure fair usage.
## Table of Contents
- [Features](#features)
- [Tech Stack](#tech-stack)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [API Endpoints](#api-endpoints)
- [Rate Limiting Details](#rate-limiting-details)
- [Contributing](#contributing)
- [License](#license)
- [Links](#links)
## Features
- **Global Rate Limiting**: Limits the number of requests per IP address to prevent abuse.
- **Login Rate Limiting**: Specifically limits login attempts to mitigate brute force attacks.
- **Security Enhancements**: Utilizes Helmet for basic security improvements.
## Tech Stack
- **Backend**: Node.js, Express
- **Rate Limiting**: express-rate-limit
- **Security**: Helmet
- **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 for future expansions. [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/rate-limiting.git
```
2. **Navigate into the project directory:**
```bash
cd rate-limiting
```
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
```
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
- **GET `/api/`**
Returns a welcome message.
**Response:**
```json
{
"message": "Welcome to the Rate Limiting API!"
}
```
- **POST `/api/login`**
Logs in a user and applies rate limiting.
**Request body:**
```json
{
"username": "string",
"password": "string"
}
```
**Response:**
```json
{
"message": "Login successful"
}
```
## Global Rate Limiter
- **Limits**: 100 requests per 15 minutes per IP
- **Message**: Too many requests from this IP, please try again later.
## Login Rate Limiter
- **Limits**: 5 login attempts per 15 minutes per IP
- **Message**: Too many login attempts from this IP, please try again later.
## 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/rate-limiting/blob/main/LICENSE) file for details.
## 🔗 Links
[]([https://www.linkedin.com/](https://www.linkedin.com/in/achref-ben-brahim-dev/))
| Node.js | Express | Rate Limiting | License |
|---------|---------|---------------|---------|
| [](https://nodejs.org/) | [](https://expressjs.com/) | [](https://www.npmjs.com/package/express-rate-limit) | [](https://github.com/AchrefDevTN/rate-limiting/blob/main/LICENSE) |