A URL shortener. Built by @matthuynh and @omardahir99

---

Try out a live version here! Note that since we are hosting the service using Heroku's Free Plan, the service may take a few moments to load up initially.

📝 Table of Contents

• Screenshots
• About
• Getting Started

• Built Using
• Authors
• Acknowledgments

📷 Screenshots

You can click on each screenshot to expand them.

🧐 About

Shrinkly is a URL shortener service. Users can input a long URL into Shrinkly and the service will provide a randomly generated shortened version of that URL. Users may also choose to create their own custom shortened URL.

Try out a live version here! Note that since we are hosting the service using Heroku's Free Plan, the service may take a few moments to load up initially.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Step 1: Ensure that you have fulfilled the following prerequisites

• $ npm -v
  • 6.13.4
• $ node -v
  • v10.16.0

Step 2: Clone this repo

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

Step 3: Install node module dependencies for the server and client

• $ cd url-shortener/server

• $ npm install

• $ cd ../client

• $ npm install

Step 4: Initialize the Mongo server

• Start up an instance of Mongo on localhost:27017. Be sure to leave this server up.
• $ mongod

Step 5: Set-up environment variables

• $ cd url-shortener/config
• $ vi default.json
• Inside this JSON file, fill out the two environment variables mongoURI and baseUrl
  • Example: { "mongoURI": "mongodb://localhost:27017/url_shortener", "baseUrl": "http://localhost:5000" }

Step 6: Run the application

• $ cd url-shortener
• $ npm run dev
  • This starts the servers on the client and server side
  • The client should start on your localhost on port 3000. To view in your browser, navigate to http://localhost:3000

⛏️ Built Using

• MongoDB - Database
• Express - Server Framework
• ReactJS - Web Framework
• NodeJs - Server Environment

✍️ Authors

• @matthuynh
• @omardahir99

🎉 Acknowledgements

• Original Node code base was adapted and expanded upon from Brad Traversy's tutorial
• README format provided by Kyle Lobo