https://github.com/dammak/punnify
https://github.com/dammak/punnify
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dammak/punnify
- Owner: DAMMAK
- Created: 2021-09-18T17:07:10.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-09-19T18:43:49.000Z (almost 5 years ago)
- Last Synced: 2025-01-14T05:27:18.239Z (over 1 year ago)
- Language: TypeScript
- Size: 56.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Punnify
URL shortener service
## How to run
```bash
npm install
#to run in dev mode
npm run dev
# to run in prod mode
npm start
```
## Usage
it has 3 available endpoints routes. `/getUrls`, `/getUrl` , `/`
### /getUrls
this endpoint return all the available url data from the database
Http Method: `GET`
example response
```Javascript
{
"data": [
{
"_id": "61476c8d2ade7ff56b35b593",
"fullUrl": "http://google.com",
"shortUrl": "HwFEnrCV",
"visited": 3,
"__v": 0
},
{
"_id": "61476e512ade7ff56b35b5af",
"fullUrl": "http://quickteller-merchant-ui.k8.isw.la/",
"shortUrl": "oqy29Kye",
"visited": 2,
"__v": 0
},
{
"_id": "61476cb32ade7ff56b35b597",
"fullUrl": "http://stackoverflow.com",
"shortUrl": "wl-k3wJk",
"visited": 1,
"__v": 0
},
{
"_id": "61476dda2ade7ff56b35b5a6",
"fullUrl": "http://calendar.google.com",
"shortUrl": "1OS1Lx1B",
"visited": 1,
"__v": 0
},
{
"_id": "614777dff4423560b6936fcd",
"fullUrl": "http://docs.google.com/document/d/1VEhuVK2K3v6IoSa8LPair6Bqo6BxWt7h7nCze34vPOg/edit",
"shortUrl": "cD3Sr8H9",
"visited": 0,
"__v": 0
}
]
}
```
### /getUrl
this endpoint returns URL data of using the `shortUrl` as the param criteria
example request: `http://localhost:5000/HwFEnrCV`
example response
```Javascript
{
"fullUrl": "http://google.com",
"shortUrl": "HwFEnrCV"
}
```
### /getUrl [POST]
this endpoint allows user to shorten URL
Http Method: `POST`
example request:
```Javascript
{
"url": "google.com"
}
```
example response
```Javascript
{
"fullUrl": "http://google.com",
"shortUrl": "HwFEnrCV"
}
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[MIT](https://choosealicense.com/licenses/mit/)