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

https://github.com/jama5262/react-link-previewer

This is a react app that displays a visual preview and brief description of the link or links passed
https://github.com/jama5262/react-link-previewer

ant-design react react-redux redux web-scraping

Last synced: 3 months ago
JSON representation

This is a react app that displays a visual preview and brief description of the link or links passed

Awesome Lists containing this project

README

          

# React Link Previewer (Client Side)
This is a simple react app that displays a visual preview and brief description of the link or links passed

[![Build Status](https://travis-ci.org/jama5262/react-link-previewer.svg?branch=server)](https://travis-ci.org/jama5262/react-link-previewer)
[![Coverage Status](https://coveralls.io/repos/github/jama5262/react-link-previewer/badge.svg?branch=server)](https://coveralls.io/github/jama5262/react-link-previewer?branch=server)

### To view the app click [here](https://react-link-preview.herokuapp.com/)

## To view the Express backend, change to `server` branch or click [here](https://github.com/jama5262/react-link-previewer/tree/server)

## Original Designs can be found here
[Original Figma Designs](https://www.figma.com/file/h4GXGbJL8x37EL63UDfVst/React-Link-Previewer?node-id=0%3A1) 🎨

# Table of Contents
- [Built With](#built-with)
- [Demos](#demos)
- [Installation](#installation)
- [Usage](#usage)
- [Support](#support)
- [License](#license)

## Built-With

- [React](https://reactjs.org/)
- [Redux](https://redux.js.org/)
- [React-Redux](https://react-redux.js.org/)
- [Axios](https://github.com/axios/axios)
- [Ant Design](https://ant.design/)

## Demos

Demo 1|
------------ |
alt text |

You can also hover over the cards to preview the wesite inside of an iFrame (***If X-Frame Options is not present***)

Demo 2|
------------ |
alt text |

## Installation

### Cloning
Clone this repo to your local machine using `https://github.com/jama5262/react-link-previewer.git`

### Installing all packages
After cloning `cd` into the project and run the following to install all packages
```
npm install
```
Great the project has been setup 👍

## Usage
To start using it locally, run the following
```
npm start
```

## Support

Reach out to me at one of the following places!

- Email at jama3137@gmail.com
- Twitter [timedjama5262](https://twitter.com/timedjama5262)

## License

```
MIT License

Copyright (c) 2019 Jama Mohamed

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```