https://github.com/goodnesskay/LARAVEL-PDF-VIEWER

A Laravel Package for viewing PDF files or documents on the web without leaving your Web Application
https://github.com/goodnesskay/LARAVEL-PDF-VIEWER

laravel laravel-5-package package pdf pdf-viewer php

Last synced: 3 days ago
JSON representation

A Laravel Package for viewing PDF files or documents on the web without leaving your Web Application

• Host: GitHub
• URL: https://github.com/goodnesskay/LARAVEL-PDF-VIEWER
• Owner: goodnesskay
• Created: 2017-01-25T18:01:42.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-07-02T04:33:49.000Z (over 7 years ago)
• Last Synced: 2024-03-14T15:49:42.240Z (8 months ago)
• Topics: laravel, laravel-5-package, package, pdf, pdf-viewer, php
• Language: JavaScript
• Homepage: https://goodnesskayode.me
• Size: 476 KB
• Stars: 85
• Watchers: 6
• Forks: 53
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Laravel PDF VIEWER

[![Latest Stable Version](https://poser.pugx.org/goodnesskay/laravelpdfviewer/v/stable)](https://packagist.org/packages/goodnesskay/laravelpdfviewer)

[![License](https://poser.pugx.org/goodnesskay/laravelpdfviewer/license)](https://packagist.org/packages/goodnesskay/laravelpdfviewer)

[![Build Status](https://scrutinizer-ci.com/g/goodnesskay/LARAVEL-PDF-VIEWER/badges/build.png?b=master)](https://scrutinizer-ci.com/g/goodnesskay/LARAVEL-PDF-VIEWER/build-status/master)

> This package is meant to help with viewing portable document file(PDF) on the web seamlessly when developing with Laravel. The package makes use of [ViewerJS](http://viewerjs.org) 

## Requirement

- [PHP](https://php.net) 5.6+ 

- [Composer](https://getcomposer.org)

- Pdf files

## Installation

To install into your project, run the command below in your terminal.

```

composer require goodnesskay/laravelpdfviewer

```

Once the package is done being installed, register the service provider. Open `config/app.php` and add the following to the `providers` key.

 ```

 Goodnesskay\LaravelPdfViewer\LaravelPdfViewerServiceProvider::class,

 ```

 

 ## Configure

 Run this in your terminal:

 ```

php artisan vendor:publish --provider="Goodnesskay\LaravelPdfViewer\LaravelPdfViewerServiceProvider" 

```

It will publish a folder named `laraview` to the root folder of your project.

##  How it Works

Simple!!! After installations and configurations have been carried out successfully, add the code below to your html file

 ```

 {{ asset('/laraview/#../folder-name/the-pdf-file.pdf') }}

```

It should look like this:

```

```

Then, you should have something like this:

![Goodness Kayode Laravel-pdfviewer](https://cloud.githubusercontent.com/assets/16525886/26499445/9483e444-422a-11e7-81cf-9569b8f33669.png)

**Note:** 

> After `#../` in `{{ asset('/laraview/#../folder-name/the-pdf-file.pdf') }}`, what should follow is the folder name of the pdf files in the public 

folder then, the pdf file name can follow.

## Contribute

You can `fork` this package, `contribute` and `submit a pull request`. I will really love it.

##  You want to appreciate me?

You can appreciate me by **starring** this repository and follow me on [Github](https://github.com/goodnesskay) , [twitter](https://twitter.com/goodnesskayode) and subscribe to my [Youtube](https://www.youtube.com/channel/UC3h5EkjLBS5VtpJRVRrMD-Q) Channel!

I love you like mad.

**Goodness Kayode | Pusher of Codes**

## License

MIT License (MIT).