Skip to content

adambrikman/short-url

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

URL Shortener

The purpose of this project is to provide you with a utility that shortens lengthy URLs.

This project was completed as part of the Free-Code-Camp curriculum.

Download

git clone https://github.com/adambrikman/url-shortener

Install

Once downloaded, in your command prompt/terminal/code editor, after navigating to the downloaded file, run the following command:

npm i

After this, create a .env file containing the following two items:

MONGO_URI=[Insert Mongo URI in this spot (without the outside square brackets). Mongo URI's can be obtained here.]

BASE_URL=http://localhost:3000/r/

To start the project, run the following script in your terminal:

npm run devStart

That's it! The project is up and running. Visit http://localhost:3000 in your browser to begin using it!

Usage

To use this project, copy a URL and paste it into the input field that says "Shorten your link."

After pasting, click the "Shorten" button. A new input field will appear below displaying your shortened URL!

Paste the shortened URL in the address bar (or share it with your friend) and you're good to go!

Releases

No releases published

Packages

No packages published