https://github.com/imran120198/url-shortener

https://github.com/imran120198/url-shortener

express-js jwt mongodb mongoose nodejs swagger

Last synced: 14 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/imran120198/url-shortener
• Owner: imran120198
• Created: 2024-08-07T10:26:06.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-08-09T10:58:22.000Z (3 months ago)
• Last Synced: 2024-11-02T22:04:16.550Z (14 days ago)
• Topics: express-js, jwt, mongodb, mongoose, nodejs, swagger
• Language: JavaScript
• Homepage: https://url-shortener-5p7p.onrender.com
• Size: 37.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# URL Shortener

This URL Shortener service allow user to register, login, shorten URL and redirect to the original URL.

## Deployment Link

https://url-shortener-5p7p.onrender.com

## Tech Stack

* Node.js

* Express.js

* MongoDB

## Documentation

https://url-shortener-5p7p.onrender.com/apidocs/

## Endpoints

1. For signup

    Endpoint - https://url-shortener-5p7p.onrender.com/user/signup

   

    Method - POST

    Request Body

    ```

      {

        "username" : your username,

        "password" : your password

      }

    

    ```

2. For Login

    Endpoint - https://url-shortener-5p7p.onrender.com/user/login

   

    Method - POST

   Request Body

    ```

      {

        "username" : your username,

        "password" : your password

      }

    

    ```

3. For Shortening URL

    Endpoint - https://url-shortener-5p7p.onrender.com/url/shorturl

   

    Method - POST

      Request Body

       ```

          "originalURL" : your url

       ```

4. For Redirect

    Endpoint - https://url-shortener-5p7p.onrender.com/url/redirect/:short

   

    Method - GET

   #### For Example

  

   ```

      "originalURL":"https://www.gurucool.life/"

      "shortURL": "https://url-shortener-5p7p.onrender.com/url/redirect/JUhpp1",

   ```