url-shortener-public/README.md

URL Shortener

This is a small project i worked on out of boredom.
Its not meant to be perfect, just an idea i had and wanted to work on to kill some time.
Its an url shortener that is meant to allow people to easily create shorted urls, even automate this task if need be.

Setup

Run git clone https://git.dommymommy.xyz/emily/url-shortener.git

Next run cd url-shortener and then run npm i

Run the sql file on your database server and add the credentials to ./config/main.json

Now you can run node main or npm start to start up the service

Usage

API

POST

/api/v1/createKey
Get Info about a shortcode

GET

/api/v1/info/<code>
Get Info about a shortcode

DELETE