https://github.com/abdussamadyisau/url-shortener-api

https://github.com/abdussamadyisau/url-shortener-api

Last synced: 9 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/abdussamadyisau/url-shortener-api
• Owner: AbdussamadYisau
• Created: 2021-02-23T02:33:11.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-08-15T10:29:18.000Z (over 3 years ago)
• Last Synced: 2023-03-09T05:36:22.050Z (almost 2 years ago)
• Language: JavaScript
• Homepage: https://url-shortener-12.vercel.app/api/url/shorten
• Size: 466 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# URL Shortener:

URL shortening service built with NodeJS, Express and Mongo DB.

## Overview

This is a backend web application that allows users to convert long URLs to more accessible and maintainable short URLs.

Utilized Express framework, Mongo DB, and [shortid](https://www.npmjs.com/package/shortid), a package which generates short non-sequential unique ids for the shortening service.

## Live Demo

Deployed the live version of the app here: [here](https://url-shortener-12.vercel.app/api/url/shorten)

- Postman Testing

  ![](assets/postmanTest.png)

## Getting Started

1. Clone the repo

```

 git clone https://github.com/AbdussamadYisau/Url-Shortener-API

 cd Url-Shortener-API

```

2. Install the dependencies:

```

npm install

```

3. Run the development server:

```

$ node index.js

```

4. Navigate to [http://localhost:8080/api/url/shortener](http://localhost:8080/api/url/shortener)