Skip to content

Latest commit

 

History

History
92 lines (66 loc) · 2.89 KB

README.md

File metadata and controls

92 lines (66 loc) · 2.89 KB
Raw

🌐 URL Shortener

A powerful URL shortener built with NestJS, PostgreSQL, and TypeORM! This project aims to provide a robust, user-friendly, and feature-rich URL shortening service.

🚀 Features

  • URL Validation: Ensure that only valid URLs are shortened. We use a library like class-validator for this purpose.
  • Custom Short URLs: Allow users to specify their own custom short URLs if desired.
  • Expiration Dates: Implement an expiration mechanism for short URLs, allowing users to set an expiry date.
  • Click Tracking: Track the number of clicks on each short URL.
  • Rate Limiting: Prevent abuse of the service with rate limiting.

🛠️ Built With

  • NestJS: A progressive Node.js framework for building efficient, reliable, and scalable server-side applications.
  • PostgreSQL: A powerful, open-source object-relational database system.
  • TypeORM: An ORM that can run in NodeJS, Browser, Cordova, PhoneGap, Ionic, React Native, NativeScript, Expo, and Electron platforms, and can be used with TypeScript and JavaScript (ES5, ES6, ES7, ES8).

📚 Getting Started

Prerequisites

  • Node.js
  • PostgreSQL
  • TypeORM

Installation

  1. Clone the repository: 
    git clone https://github.com/riteshporiya/ShortenURLsWithNest.git
cd ShortenURLsWithNest
  2. Install dependencies:
npm install
  1. Configure the database:
# Create a .env file and set your PostgreSQL connection details
DB_HOST=localhost
DB_PORT=5432
DB_USERNAME=your_username
DB_PASSWORD=your_password
DB_NAME=your_database
DB_MIGRATION_TABLE_NAME=migrations
  1. Run database migrations:
npm run typeorm migration:run:local
  1. Start the server:
npm run start:dev

🔧 Usage

URL Validation

Ensure only valid URLs are shortened using validator.

Custom Short URLs

Allow users to create custom short URLs by specifying a desired alias.

Expiration Dates

Set an expiry date for short URLs, after which they will no longer be accessible.

Click Tracking

Track the number of clicks for each short URL to monitor usage.

Rate Limiting

Prevent abuse by limiting the number of requests a user can make in a given time period.

🏗️ Architecture

  • Custom Decorator: Uses a custom decorator to set rate limit metadata on routes.
  • Interceptor: Implements an interceptor to handle rate limiting logic.
  • Dependency Injection: Uses NestJS's dependency injection system and module structure.
  • Reflector: Utilizes the Reflector to access metadata.
  • HttpException: Throws a standard HttpException for rate limit errors.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🤝 Contributing

Contributions are welcome! Please open an issue or submit a pull request for any changes or enhancements you would like to see.

Happy coding! 🎉