README.md

.Shorty URL (URL Shortener)

Shorten your URLs, and keep track of the amount of clicks of YOUR link!

Live App - Here

Contents

• .Shorty URL (URL Shortener)
• Contents
  • Why?
  • Tech Used
  • Installation (to run locally)
  • Want to Contribute?

Why?

• Shorten long urls
• Keep track on the amount of clicks of YOUR link
  • e.g) track the amount of entries to a site, given YOUR link

Tech Used

• NodeJS/npm
• ExpressJS
• ReactJS
• MongoDB
• PassportJS

Installation (to run locally)

1. Clone the repo $ git clone https://github.com/JP-sDEV/url_shortener.git

2. install node dependencies npm install from the root folder

3. install client dependencies cd client npm install

4. Run app locally with npm run dev from the root folder

Want to Contribute?

1. Clone the repo by following Installation
2. Improve the web-app by:
   • add a feature
   • resolving an issue in the Issues tab
   • refactor code
3. Test the new feature locally
4. Open a pull request with a detailed explanation of the changes