varshil-shah / url-shortner-backend

A simple url shortner, which converts long url into short url also provides analytics on urls.

Url shortener backend

Introduction

Welcome to the URL Shortener project! This tool allows you to shorten long URLs into concise, manageable links. Whether you need to share links on social media, in emails, or simply want to track click statistics, this URL shortener has you covered.

Features

1. Shorten URLs
2. Track click statistics
3. Share links on social media
4. Send links via email
5. QR code generation
6. Statistics dashboard
7. User authentication using JWT and OAuth2 (Github)
8. All CURD operations on links, users, and statistics

Installation

Requirements:

1. Node.js
2. MongoDB account
3. Github OAuth app
4. Postman (optional)

Steps

1. Clone the repository git clone https://github.com/varshil-shah/url-shortner-backend.git
2. Run npm install or yarn
3. Create a .env file in the root directory based on .env.example
4. Run npm start or yarn start

Tech Stack

1. Node.js
2. Express.js
3. MongoDB