Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/katerinutkina/pdf-crop
React + TypeScript + Vite + Tailwind
https://github.com/katerinutkina/pdf-crop
canvas pdf react tailwind typescript vite
Last synced: 11 days ago
JSON representation
React + TypeScript + Vite + Tailwind
- Host: GitHub
- URL: https://github.com/katerinutkina/pdf-crop
- Owner: KaterinUtkina
- Created: 2024-07-13T15:06:03.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-08-09T09:13:19.000Z (3 months ago)
- Last Synced: 2024-08-09T10:42:42.786Z (3 months ago)
- Topics: canvas, pdf, react, tailwind, typescript, vite
- Language: TypeScript
- Homepage:
- Size: 1.73 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PDF Crop
PDF Crop is a React-based application designed for loading PDF documents, displaying them on a canvas, and allowing users to select area for cropping into images.
## Table of Contents
- [Features](#features)
- [Live Demo](#live-demo)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
## Features
- PDF document loading
- Canvas-based display of PDF documents
- Area selection for cropping into images
## Live Demo
Check out the live demo of the PDF Crop: [PDF Crop Live Demo](https://katerinutkina.github.io/pdf-crop/)
## Getting Started
### Prerequisites
Ensure you have the following installed on your local machine:
- [Node.js](https://nodejs.org/) (version 20 or higher)
- [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/)
### Installation
1. Clone the repository:
```bash
git clone https://github.com/KaterinUtkina/pdf-crop.git
cd pdf-crop
2. Install the dependencies:
Using npm:
```bash
npm install
```
Using yarn:
```bash
yarn install
```
### Usage
To start the development server, run:
Using npm:
```bash
npm run dev
```
Using yarn:
```bash
yarn dev
```
Open your browser and navigate to http://localhost:3000 to see the application running locally.