Skip to content

Latest commit

 

History

History
36 lines (26 loc) · 1.23 KB

README.md

File metadata and controls

36 lines (26 loc) · 1.23 KB
Raw

URL Shortener webApp - nanoURL

This project is a simple URL shortener service built using Node.js. The goal of the project is to take long and unwieldy URLs and shorten them into a more manageable format.

Features

  • User can input a long URL and the service will generate a shortened URL
  • User can access the original long URL by visiting the shortened URL
  • User can search for a specific shortened URL
  • User can copy the shortened URL to clipboard

Getting Started

  1. Clone the repository to your local machine.
  2. Install the necessary dependencies by running the command

npm install

  1. Start the server by running the command

npm run build

  1. Provide the mongodb://localhost:27017 URI in the Environment Varibles to connect to your local database.
  2. The application should now be running on port 3030 or the port provided in yout Environment variables.

Dependencies

  • Node.js
  • Express
  • Crypto
  • Mongoose
  • Mongoose-type-url
  • Dotenv

Contributors

Manish Madan

Contributions

If you would like to contribute to the project, please fork the repository and make your changes in a separate branch. Once you are satisfied with your changes, submit a pull request for review.