An open API service indexing awesome lists of open source software.

https://github.com/vrun545/url-shortner

An URL shortener is a website that reduces the length of your URL (Uniform Resource Locator). The idea is to minimize the web page address into something that's easier to remember and track.
https://github.com/vrun545/url-shortner

Last synced: 2 months ago
JSON representation

An URL shortener is a website that reduces the length of your URL (Uniform Resource Locator). The idea is to minimize the web page address into something that's easier to remember and track.

Awesome Lists containing this project

README

          

# URL Shortner
An URL shortener is a website that reduces the length of your URL (Uniform Resource Locator). The idea is to minimize the web page address into something that's easier to remember and track.

**ExpressJS Node.js Project with MongoDB and JWT Authentication**

## Overview
This project is a robust URL shortener built with Express.js and Node.js, backed by MongoDB for data storage. The application adheres to the MVC (Model-View-Controller) architectural pattern for a clean and organized codebase. User authentication is implemented using JWT (JSON Web Token) for secure access to the shortened URL management features.

## Sample Images of Project

![Screenshot (230)](https://github.com/vrun545/URL-Shortner/assets/63057049/138eb71e-1652-4cab-b579-b1d4ad4ab1cf)

![Screenshot (231)](https://github.com/vrun545/URL-Shortner/assets/63057049/7c469811-80a4-42b1-9298-d7a3e6004822)

## Features

- **URL Shortening:** Easily create short URLs for long web addresses.
- **MVC Architecture:** Structured codebase following the MVC design pattern for maintainability and scalability.
- **User Authentication:** Secure user access with JWT authentication.

## Technologies Used

- **Express.js:** A fast and minimalist web application framework for Node.js.
- **Node.js:** A JavaScript runtime for server-side development.
- **MongoDB:** A NoSQL database for efficient storage of URL data.
- **JWT:** JSON Web Tokens for secure and stateless user authentication.

## Getting Started

### Prerequisites

- Node.js and npm installed
- MongoDB installed and running

### Installation

1. Clone the repository:

```bash
git clone https://github.com/vrun545/url-shortener.git
cd url-shortener
```

2. Install dependencies:

```bash
npm install
```

### Usage

Start the application:

```bash
npm start
```

Visit [http://localhost:8001](http://localhost:8001) in your browser.

## Contributing

If you'd like to contribute to this project, please follow the [Contributing Guidelines](CONTRIBUTING.md).

## License

This project is licensed under the [MIT License](LICENSE).