https://github.com/linkpreview/linkpreview

Open Graph, Twitter Card, Oembed preview. Shows visual cards that mimic link previews in Social Media like facebook, twitter, vk and other sites that support link preview.
https://github.com/linkpreview/linkpreview

cheeriojs linkpreview nodejs oembed opengraph react reactjs redux scraper scraping twittercard

Last synced: about 1 month ago
JSON representation

Open Graph, Twitter Card, Oembed preview. Shows visual cards that mimic link previews in Social Media like facebook, twitter, vk and other sites that support link preview.

• Host: GitHub
• URL: https://github.com/linkpreview/linkpreview
• Owner: linkpreview
• License: mit
• Created: 2019-05-30T10:45:14.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-27T14:09:30.000Z (about 1 year ago)
• Last Synced: 2024-04-15T07:23:15.840Z (5 months ago)
• Topics: cheeriojs, linkpreview, nodejs, oembed, opengraph, react, reactjs, redux, scraper, scraping, twittercard
• Language: JavaScript
• Homepage:
• Size: 2.1 MB
• Stars: 71
• Watchers: 4
• Forks: 10
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Notice !! Not maintained any more.

![Link Preview Logo](https://raw.githubusercontent.com/namchey/linkpreview/master/app/images/linkpreview-logo.png)

# Link Preview

[![npm version](https://badge.fury.io/js/%40namchey%2Flinkpreview.svg)](https://badge.fury.io/js/%40namchey%2Flinkpreview)

[![Build Status](https://travis-ci.org/namchey/linkpreview.svg?branch=master)](https://travis-ci.org/namchey/linkpreview)

[![Maintainability](https://api.codeclimate.com/v1/badges/f8aae8449e8d187af9aa/maintainability)](https://codeclimate.com/github/namchey/linkpreview/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/f8aae8449e8d187af9aa/test_coverage)](https://codeclimate.com/github/namchey/linkpreview/test_coverage)

Open Graph, Twitter Card, Oembed preview. Shows visual cards that mimics link previews in social media like facebook, twitter, vk, viber and other sites that support link preview.

# Motivation

 There are already tools from facebook (https://developers.facebook.com/tools/debug/) and twitter(https://cards-dev.twitter.com/validator) that does the work of debugging the link preview. But we also wanted Oembed standard testing and various other debugging. We wanted a tool for our development environment that supports all kind of link preview standards. So Link Preview was made to solve these problems.It is an all in one debugger. It shows visual link previews for OpenGraph, Twitter Card and Oembed protocol. With this tool you can get somewhat similar link preview in sites like facebook, twitter, medium, etc.

# Requirements

  1. Node.js v10.16.0

  ```

  nvm install v10.16.0

  ```

# Installation

    ````

    npm i -g @namchey/linkpreview

    linkpreview

    //starts a server in localhost:8080

    ````

# Development

1. Clone this repo

  ````

  git clone [email protected]:linkpreview/linkpreview.git

  ````

2. Install Dependencies

  ````

  npm i

  ````

3. Copy `.env.example` ---> `.env` if you want custom env vars

4. Webpack Build

  ````

  //server-rendering

  npm run build:dev

  //client

  npm run app-dev-server

  ````

5. Run in Development mode

  ````

  npm run dev

  //open app in browser, default is http://localhost:4040

  ````

# Production

  1. Build

  ````

  npm run build

  ````

  2. Run

  ````

  npm run start

  ````

  # Libraries Used for Scraping

   - [cheeriojs/cheerio](https://github.com/cheeriojs/cheerio)

   - [MattMcFarland/SUq](https://github.com/MattMcFarland/SUq)