Giter Club home page Giter Club logo

wissemhammami009 / backend-urlshort-app Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 82 KB

The Backend URL Shortener is a powerful and efficient application designed to handle URL shortening operations. This lightweight backend service allows you to generate shortened URLs programmatically, making it an ideal solution for developers looking to integrate URL shortening capabilities into their applications.

Home Page: https://backend-urlshort-app.vercel.app

JavaScript 93.40% HTML 6.49% CSS 0.11%

backend-urlshort-app's Introduction

Backend URL Shortener

The Backend URL Shortener is a powerful and efficient application designed to handle URL shortening operations. This lightweight backend service allows you to generate shortened URLs programmatically, making it an ideal solution for developers looking to integrate URL shortening capabilities into their applications.

Features

  • URL Shortening: Generate shortened URLs by sending a HTTP request to the backend API, providing the long URL as a parameter.
  • Customizable Short Links: Optionally include custom keywords or tags to create personalized and meaningful short URLs.
  • Analytics and Statistics: Track and analyze the usage of your shortened URLs, including click counts and other relevant metrics.
  • Scalable and Fast: The backend is built to handle high volumes of requests efficiently, ensuring minimal latency and optimal performance.
  • Easy Integration: Integrate the URL shortening functionality seamlessly into your existing applications using the provided API endpoints.

Getting Started

Prerequisites

To run the Backend URL Shortener, you'll need the following:

  • Node.js
  • MongoDB

Installation

  1. Clone the repository:https://github.com/WissemHammami009/backend-urlshort-app

  2. Install the dependencies:

  3. Configure the environment variables:

create the .env file and update the necessary configuration variables such as the database connection URL and any other relevant settings.

Environment Variable Description
MONGO_URI URI to connect to the database
PORT The port number for the application (default: 3000)
EMAIL_USERNAME Username for the email account used for sending emails
EMAIL_PASSWORD Password for the email account used for sending emails
EMAIL_LINK Your application base link + "/r/"
MAIN_KEY JWT secret key composed of 64 bytes
  1. Start the server:

The backend server will start running on http://localhost:3000.

API DOCUMENTATION

From Here(Postman): https://documenter.getpostman.com/view/19986591/2s93sW8aqB

backend-urlshort-app's People

Contributors

wissemhammami009 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.