URL Shortener 🔗

A simple web application built with Node.js, Express, and MongoDB for you to readily get a shortened URL to use

Trial in this project 🤠

To increase user experience

• Animate.css is used to show animation for certain actions

---

Project First Look

User Stories

1. User can input a set of URL aiming to be shortened
2. User can get a warning message for invalid URL format input
3. User can get a set of shortened URL from the original URL provided
4. User can copy the shortened URL to clipboard by clicking the copy button
5. User can reset the input columns for next URL generation
6. User can be redirected to the original URL by visiting the shortened URL

---

Installation

The following instructions will get you a copy of the project and all the setting needed to run it on your local machine.

Prerequisites

• npm
• Node.js v10.16.0
• MongoDB v4.0.10

Clone

Clone this repository to your local machine

$ git clone https://github.com/smallpaes/url-shortener.git

Setup

1. Enter the project folder

$ cd url-shortener

2. Install npm packages

$ npm install

3. Activate the server

$ npm run dev

4. Find the message for successful activation

> App is running
> mongodb connected!

You may visit the application on browser with the URL: http://localhost:3000

---

FAQ

• Can I try this app online?
  • Yes, kindly visit https://ancient-cove-62781.herokuapp.com/

---

Authors

Mike Huang