Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rooyca/pdf2slide
PDF2Slide is a Vue project to display PDFs in a more aesthetic way.
https://github.com/rooyca/pdf2slide
fastapi mongodb pdf pdf-viewer vue vue3
Last synced: 3 months ago
JSON representation
PDF2Slide is a Vue project to display PDFs in a more aesthetic way.
- Host: GitHub
- URL: https://github.com/rooyca/pdf2slide
- Owner: Rooyca
- Created: 2022-07-20T21:52:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-10T16:22:26.000Z (5 months ago)
- Last Synced: 2024-09-10T18:49:35.460Z (5 months ago)
- Topics: fastapi, mongodb, pdf, pdf-viewer, vue, vue3
- Language: Vue
- Homepage:
- Size: 5.86 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PDF2Slide - Convert PDF to Slides (Frontend)
## Table of Contents
- [About](#about)
- [Demo](#demo)
- [Screenshots](#screenshots)
- [Technologies Used](#technologies-used)
- [Features](#features)
- [Development](#development)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [Contact](#contact)
## About
This is the frontend of the project PDF2Slide. It's a tool that allows you to convert PDF files to slides. It's currently in development and you are strongly encouraged to help us improve it.
- Check out the Back-end [here](https://github.com/Rooyca/PDF-Vision-BE)
## Demo
- ~You can see a demo here.~
- Or you can see a showcase [here](https://portafolio.ankladigital.com/)
## Technologies Used
- Celery (to make asynchronous tasks)
- Redis (to store queues)
- MongoDB (to store results)
- FastAPI (as backend)
- Vue 3 (as frontend)
- [NEW] Docker
- [NEW] https://transfer.sh/ (to store the images)
- [NEW] https://fly.io (to deploy)
## Features
- [x] Convert PDF to Slides.
- [x] Delete slides.
- [ ] Charging text when loading slides for the first time.
- [ ] Download slides.
## Docker
### Variables
- You should edit the file `docker-compose.yml` and change the following variables:
```bash
- SMTP_SERVER=smtp-relay.sendinblue.com
- [email protected]
- SMTP_PASS=password
- SMTP_PORT=587
- [email protected]
- S3_ENDPOINT=https://11111.r2.cloudflarestorage.com
- KEY_ID=id
- KEY_SECRET=secret
- URL_STORAGE=https://example.com/
```
For `S3_ENDPOINT` you can use the cloudflare storage or any other storage that supports S3.
- After that you can run the following command:
```bash
docker-compose up -d
```
## Development
### Prerequisites
- Node.js
- npm
### Installation
- Clone the repository
- Run `npm install` to install all the dependencies
- Run `npm run dev` to start the development server
- Go to `localhost:3000` to view the app
## Usage
- "If you want to delete a slide later, you must make sure to save the `delete key`, then you can go to the url `http://localhost:3000/del/{slide_id}/{delete_key}`
## Contributing
Contributions are always welcome! <3
## Contact
You can contact me at:
- [Mas.to](https://mas.to/@rooyca)
- [Telegram](https://t.me/yarocc)