Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smallpaes/url-shortener
A simple web application built with Node.js, Express, and MongoDB for you to readily get a shortened URL to use
https://github.com/smallpaes/url-shortener
animatecss expressjs mongodb mongoose url url-shortener
Last synced: 24 days ago
JSON representation
A simple web application built with Node.js, Express, and MongoDB for you to readily get a shortened URL to use
- Host: GitHub
- URL: https://github.com/smallpaes/url-shortener
- Owner: smallpaes
- Created: 2019-07-24T06:51:23.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T23:28:49.000Z (almost 2 years ago)
- Last Synced: 2023-03-03T02:21:24.021Z (over 1 year ago)
- Topics: animatecss, expressjs, mongodb, mongoose, url, url-shortener
- Language: JavaScript
- Homepage: https://ancient-cove-62781.herokuapp.com/
- Size: 4.42 MB
- Stars: 7
- Watchers: 1
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://daneden.github.io/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](https://www.npmjs.com/get-npm)
- [Node.js v10.16.0](https://nodejs.org/en/download/)
- [MongoDB v4.0.10](https://www.mongodb.com/download-center/community)
### 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/](https://ancient-cove-62781.herokuapp.com/)
___
## Authors
[Mike Huang](https://github.com/smallpaes)