Skip to content

MarcusTXK/Shorty

Repository files navigation

Shorty Build Status

Shorty is url shortener that aims to create unique shortened urls from longer urls. A random shortened url will be created if no ‘customUrl’ is specified (minimum length of 1, maximum of length 10). All shortened urls/custom urls have to be unique. When the user visits the shortened url, the goal is to provide them with the original url so that they can visit the original url with just the shortened url.

A shortened url will also have an option of being password protected with a password with a minimum of length 5. If a shortened url has a password, the user will be unable to get the original url from just the id, but must post the correct password to get access to the original url.

Running the app

For development, run backend in watch mode and database seperately

# Run cassandra seperately
$ docker-compose -f docker-compose.dev.yml up

# Run backend in watch mode
$ cd backend
$ npm run start:dev

Alternatively, run the backend in one go with

$ docker-compose up --build

For frontend

# Run frontend in watch mode
$ cd frontend
$ npm run dev

image image

About

A URL shortener with optional password protection, built with NextJS, Chakara UI, NestJS, Cassandra and Docker

Resources

Stars

Watchers

Forks

Packages

No packages published