Skip to content

Getting Started

SlidesGen is a system used to generate PowerPoint slides from pdf files. A user uploads a pdf, select the pages they want to convert to slides, and the system generates a PowerPoint presentation using LLMs.

This guide will introduce the structure of the app and how to clone the repo.

Overall Structure

The app consists of two main components: the backend and the frontend. The overall folder structure is as follows:

SlidesGen/
├── backend/
│
├── frontend/
│
├── docs/
│
│── .github/
│
└── compose.dev.yaml

The backend directory contains the FastAPI server that handles generates the slides. The frontend directory contains the web application. The docs directory contains the documentation for the project (the one you are currently reading). The .github directory contains GitHub workflows for CI/CD. The compose.dev.yaml file is a Docker Compose configuration for local development.

Prerequisites

Ensure you have the following installed on your machine:

  • Git
  • Python
  • Node.js and npm (Preferably via nvm)
  • Docker

You can run the app without Docker, but it is recommended to use Docker to have the same configuration as the production environment and maintain a consistent setup across different machines.

The use of Python and Node.js is optional if you are using Docker, but it is recommended to have them so that the IDE can provide better support.

Cloning the Repository

To clone the repository, run the following command in your terminal:

git clone https://github.com/Educuational-System-E-Learning-at-SEU/SlidesGen.git
cd SlidesGen