Skip to content

Latest commit

 

History

History
89 lines (53 loc) · 1.75 KB

README.md

File metadata and controls

89 lines (53 loc) · 1.75 KB
Raw

NexaLinks

URL Shortener

A simple and efficient URL shortener service.

Table of Contents

Overview

The URL shortener is a service that takes long URLs and converts them into short, easy-to-share links. This project provides a simple implementation of a URL shortening service, allowing users to create and manage short URLs.

Features

  • Shorten long URLs.
  • Redirect users from short URLs to the original long URLs.
  • Track basic analytics such as the number of clicks on a short URL.
  • Customizable short URL generation.
  • Secure and scalable architecture.

Requirements

  • Node.js (version 18.17.1)
  • MongoDB (version any)
  • Any additional dependencies...

Installation

Clone the repository:

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

backend:

  1. Install dependencies:

    cd server
npm install

  2. Start the server:

    npm run dev

Frontend:

  1. Install dependencies:

    cd cient
npm install

  2. Configure the application by updating the configuration file (config.js) with your MongoDB connection details and other settings.

  3. Start the server:

    npm start

The URL shortener service should now be running on http://localhost:8080.

Usage

  1. Access the URL shortener service through the web interface or use the API endpoints.

  2. Shorten a URL by submitting it through the provided interface or by making a POST request to the /api/shorten endpoint.

  3. Share the generated short URL.

  4. Users clicking on the short URL will be redirected to the original long URL.