Tiny URL Microservice

The Tiny URL Microservice is a simple URL shortening service built with Nest.js. It allows users to create shortened versions of long URLs, making them easier to share. This README provides an overview of the project, how to run it, and details about available routes.

Table of Contents

• Project Overview
• Prerequisites
• Getting Started
  • Using Docker Compose
  • Using .env File
• API Routes
• Testing
• Contributing
• License

Project Overview

This project is a simple URL shortening microservice built with Nest.js. It provides the following features:

• URL Shortening: Convert long URLs into short, easy-to-share versions.
• URL Expansion: Expand shortened URLs to their original long form And redirect users to the original URL.

Prerequisites

Before you begin, ensure you have met the following requirements:

• Node.js installed on your machine.
• Docker and Docker Compose (if you prefer to use Docker).
• .env file (if not using Docker) with the necessary environment variables. You can use .env.exmaple as a reference.

Getting Started

To get the project up and running, follow the instructions below.

Using Docker Compose

1. Clone the repository:

  git clone https://git.dayanhub.com/kfir/tiny-url-microservice.git
  cd tiny-url-microservice
  docker-compose -f docker-compose.yaml up -d --build

Your Nest.js server should now be running on port as like the port from the .env file.

Using .env File

1. Create a .env file in the root directory of your project.
2. Add the necessary environment variables to the .env file as shown below.
3. run npm run start:dev to start the server.

API Routes

Shorten URL:

• Endpoint: POST /url-shortener/shorten
• Request Body: { "url": "https://example.com" }
• Response: { "data": "abc123", "status": 201 } Expand URL:

Endpoint: GET /url-shortener/:shortUrl Response: Redirects to the original long URL or redirect to the client UI 404 page if not found.

Testing

To run the tests, run the following command:

npm run test