Live Link: Live API
- Node.js + Express
- Redis (Rate Limiting and Caching)
- Docker (Containerization)
PostMan Speed Difference because pf caching:
We welcome contributions to this project! If you would like to contribute, please follow these steps:
-
Fork the Repository:
- Click on the "Fork" button at the top right corner of this repository's GitHub page.
-
Clone the Forked Repository: To clone the repository, use the following command:
git clone https://github.com/VrajVyas11/Redis_Rate_Limiting_API.git
-
Navigate to the Project Directory:
cd Redis_Rate_Limiting_API
-
Install Dependencies: Ensure you have Node.js and npm installed, then run:
npm install
-
Set Up Environment Variables: Create a
.env
file in the root directory and add the necessary environment variables as specified in.env.example
. -
Start the Server: Run the following command to start the server:
npm start
-
Run Tests: To run tests, use:
npm test
-
Build Docker Image: To build the Docker image, use:
docker build -t redis-rate-limiting-api .
-
Run Docker Container: To run the Docker container, use:
docker run -p 3000:3000 redis-rate-limiting-api
You can test the API endpoints directly by sending requests to the following URLs:
- Home Page:
https://redis-rate-limiting-api.onrender.com/
- Get Products:
https://redis-rate-limiting-api.onrender.com/products
- Product Details:
https://redis-rate-limiting-api.onrender.com/product/:id
(Replace:id
with the actual product ID) - Place Order:
https://redis-rate-limiting-api.onrender.com/order/:id
(Replace:id
with the actual product ID)
For more detailed API functionality and parameters, refer to the project’s source code and API documentation within the repository.
For any issues or suggestions, please feel free to open an issue on the GitHub repository.
Let me know if there are any other changes you'd like to make!