Skip to content

A REST API made with NestJS and Clean Architecture to create shorter aliases for long URLs

Notifications You must be signed in to change notification settings

DanielSuhett/Tiny

Repository files navigation

Nest Logo

Tiny URL

Tiny URL is a REST API shortening service built with NestJS and Clean Architecture principles, designed to create shorter aliases for long URLs. This allows for easier sharing and tracking of URLs.

Features

  • URL Shortening: Convert long URLs into manageable short links.
  • Redirection: Redirect short URLs to their original destinations.

Getting Started

Prerequisites

What things you need to install the software and how to install them.

node -v  &&
npm -v && 
docker -v && 
docker-compose -v

Installing

A step-by-step series of examples that tell you how to get a development environment running.

  1. Clone the repository:
   git clone https://github.com/yourusername/tiny-url.git
  1. Install NPM packages:
  npm install
  1. Use docker to run:
npm run docker:dev

Running the Tests

npm run test

Built With

  • NestJS - The framework used
  • TypeORM - ORM used
  • Docker - Containerization platform
  • Clean Architecture

About

A REST API made with NestJS and Clean Architecture to create shorter aliases for long URLs

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published