Code Monkey home page Code Monkey logo

link-shortner's Introduction

Link Shortener

This is a api service that provides a link shortening functionality. It allows users to create a short code for a long URL and then redirect to the original URL by accessing the short code. The backend is built using Node.js, Express, and MongoDB.

Installation

  1. Clone the repository using git clone https://github.com/yourusername/link-shortener-backend.git

  2. Install dependencies using npm install

  3. Create a .env file and add the following variables:

    PORT=3000
    MONGODB_URI=<Your MongoDB connection URI>
    

    Replace <Your MongoDB connection URI> with your MongoDB connection string.

  4. Run the server using npm start

API Endpoints

  • GET /

    Returns a simple message indicating that the server is running.

  • GET /short/:shortCode/:originalURL

    Creates a short code for a long URL. :shortCode is the short code to be created and :originalURL is the long URL to be shortened. Returns a message indicating the short code has been created.

  • GET /:shortCode

    Redirects to the original URL associated with a short code. :shortCode is the short code to be redirected to.

Error Handling

If the short code provided in the GET /:shortCode endpoint does not exist, a 404 status code is returned with a message indicating that the short code was not found.

Dependencies

  • express: a web application framework for Node.js
  • mongoose: an Object-Document Mapping library for MongoDB
  • dotenv: a zero-dependency module that loads environment variables from a .env file

link-shortner's People

Contributors

vaib215 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.