Link-Previewer API is a API that provides metadata eg: Title, Thumbnail/Favicon, Description of a given URL.
Express.js
Cheerio
- Fork the repo to your account.
- Clone the repo to your local computer
git clone <fork url>
- Make sure Node js is installed on your machine.
- cd into the project directory and run
npm install
- Now run
nodemon server
- Open http://localhost:8000 on a browser.
https://link-pre-viewer.herokuapp.com/api/v1
Make a post request on the endpoint https://link-pre-viewer.herokuapp.com/api/v1
with url
in the body
of the request.
{
success: true,
data: {
title: "title of the given url"
image: "image of the given url"
favicon: "favicon of the given url"
url: "the given url itself"
}
}
- To get started with
Express JS
or brush up your skills, check out the official Express JS Documentation. - To get started with
Cheerio
or brush up your skills, check out the official Cheerio Documentation.