Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/withspectrum/micro-open-graph

A tiny Node.js microservice to scrape open graph data with joy.
https://github.com/withspectrum/micro-open-graph

micro microservices nodejs opengraph scraper

Last synced: 13 days ago
JSON representation

A tiny Node.js microservice to scrape open graph data with joy.

Host: GitHub
URL: https://github.com/withspectrum/micro-open-graph
Owner: withspectrum
License: mit
Archived: true
Created: 2017-02-21T13:10:50.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2021-01-01T09:04:24.000Z (almost 4 years ago)
Last Synced: 2024-08-01T02:29:26.479Z (3 months ago)
Topics: micro, microservices, nodejs, opengraph, scraper
Language: JavaScript
Size: 192 KB
Stars: 380
Watchers: 6
Forks: 51
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

# `micro-open-graph`

A tiny Node.js microservice to scrape open graph data with joy.

Running this microservice you won't need a backend solely to get some meta information about links your users submit. Press the deploy button below and show your users what the links they're clicking on contain!

## Deployment

Your own `micro-open-graph` is one click away:

[![Deploy to now](https://deploy.now.sh/static/button.svg)](https://deploy.now.sh/?repo=https://github.com/withspectrum/micro-open-graph)

You can also deploy with a single command from the terminal (assuming you have [`now`](https://now.sh) installed):

```sh
now withspectrum/micro-open-graph
```

## Usage

To get the data for a given URL, for example `mxstbr.blog`, simply add that URL (safely escaped) to the `url` query parameter:

```sh
https://your-url.now.sh/?url=http://mxstbr.blog
```

And you will get the parsed data in the following format:

```JSON
{
"author": null,
"date": "2017-02-16T11:00:00.000Z",
"description": "Fresh thinking and expert tips about HTML, CSS, JavaScript and other web technologies.",
"image": "http://mxstbr.blog/social_media.png",
"publisher": "",
"title": "",
"url": "http://mxstbr.blog/"
}
```

> Note: Not all of this, or even more, data might be available depending on the `meta` tags the page has in its HTML. (see [`metascraper`](https://github.com/microlinkhq/metascraper/blob/master/README.md#rules) for the full list of supported properties)

We infer the data from more places than just the open graph meta tags, we also support twitter meta tags and fallback to standard HTML tags like e.g. the `title` tag if no open graph data was specified. Results are cached in memory for 24 hours, which means calling this with the same URL repeatedly won't have a large impact on your server!

## Development

```sh
git clone [email protected]:withspectrum/micro-open-graph.git
npm run dev
```

The server will then be listening at `localhost:3000`.

## Updating

The `master` branch of this repository is what you will be deploying. To update to a new version with potential bugfixes, all you have to do is run the `now` command again and change the URL you call in your app! 👌

## License