Skip to content

oreoluwadnd/URL-SNIPPER

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

URL SNIPPER

A contemporary, simple, and lightweight URL shortener API using Node.js and MongoDB.

Requirements

  • Git
  • Node.js
  • MongoDB

Installation

If you want to test it locally, you can follow the following steps to install and run it successfully.

  1. Clone the repository git clone https://github.com/oredotjs/URL-SNIPPER

  2. Install the dependencies npm install

  3. Run the server npm start

  4. Test the API using Postman or any other API testing tool

Usage

This API is public and hosted by Vercel for education purposes. So if you are interested in testing it without cloning and running locally, it is also hosted online, feel free to play around referring to the Documentation. The API is a RESTful API that allows you to perform the following operations:

  • Create a new short URL
  • Create a new custom short URL
  • Get all short URLs
  • Redirect to the original URL

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

About

✂️ A contemporary, simple, and lightweight URL shortener

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors