Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vue-pdf-viewer/starter-vpv-nuxt-ts
Vue PDF Viewer Starter Toolkit with Nuxt
https://github.com/vue-pdf-viewer/starter-vpv-nuxt-ts
composition-api nuxt nuxt3 pdfjs pdfjs-dist typescript vue-library vue-pdf vue-pdf-viewer vue3 vuejs
Last synced: about 14 hours ago
JSON representation
Vue PDF Viewer Starter Toolkit with Nuxt
- Host: GitHub
- URL: https://github.com/vue-pdf-viewer/starter-vpv-nuxt-ts
- Owner: vue-pdf-viewer
- Created: 2024-07-04T02:56:22.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-07-30T09:14:27.000Z (about 2 months ago)
- Last Synced: 2024-09-18T17:15:20.091Z (9 days ago)
- Topics: composition-api, nuxt, nuxt3, pdfjs, pdfjs-dist, typescript, vue-library, vue-pdf, vue-pdf-viewer, vue3, vuejs
- Language: Vue
- Homepage: https://www.vue-pdf-viewer.dev/
- Size: 142 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# VPV Starter Toolkit in Nuxt 3 (SSR)
Welcome to the Vue PDF Viewer (VPV) starter toolkit! This repository provides a comprehensive guide on how to use VPV with Nuxt via the Composition API and TypeScript. This repo showcases how VPV can be integrated and rendered as part of a Nuxt project.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Project Setup](#project-setup)
- [Running the Example Project](#running-the-example-project)
- [Examples](#examples)
## Installation
To get started, please clone this repo to your local machine and install the dependencies:
```bash
git clone https://github.com/your-username/starter-vpv-nuxt-ts.git
cd starter-vpv-nuxt-ts
npm install
```
## Usage
### Project Setup
1. **Clone the Repository**: If you haven't already, clone the repository and navigate into the project directory.
```bash
git clone https://github.com/your-username/starter-vpv-nuxt-ts.git
cd starter-vpv-nuxt-ts
```
2. **Install Dependencies**: Install the necessary dependencies using npm or yarn
```bash
npm install
# or
yarn install
# or
pnpm install
# or
bun install
```
_Remark: For `pnpm`, there is a bit more configuration required which can be found [here](https://docs.vue-pdf-viewer.dev/troubleshooting.html#_3-resolving-peer-dependency-version-mismatch-with-pnpm)._
### Running the Example Project
This repo includes an example project to demonstrate how to use VPV. To run the example project:
1. **Serve the Application**: Use the following command to start the development server
```bash
npm run dev
# or
yarn dev
# or
pnpm run dev
# or
bun run dev
```
2. **Open in Browser**: Open your browser and navigate to `http://localhost:3000` (or the port specified in your terminal) to see the example project in action
### Using the VPV Component
Once the example project is running, you can explore the source code to see how the VPV component is integrated. Here is a brief overview:
1. **Import the component**: Import the desired VPV component into your Vue file
```js
import { VPdfViewer } from '@vue-pdf-viewer/viewer';
```
2. **Use the component in the template**: Add the VPV component to your template section
```html
```
## Examples
For more examples, please refer to the `src/App.vue` file in this repository:
- Default Toolbar
- Without Toolbar
- Mobile View
_Remark: If you would like more examples, feel free open an issue._
For more configurations, please check the [documentation](https://docs.vue-pdf-viewer.dev) site.
---
Thank you for using Vue PDF Viewer! We hope this toolkit helps you build amazing Nuxt applications. If you have any questions or need further assistance on this example, please feel free to open an issue. Happy coding!