From 064654eed7c59061926f602ed69739f35b82d7ef Mon Sep 17 00:00:00 2001 From: Suraj Jha Date: Sat, 24 May 2025 15:48:40 +0545 Subject: [PATCH] Update README.md: Add docker run instructions --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 61312de9..a7e201d8 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,23 @@ * ✅ **Export Ready** — Save as PowerPoint (PPTX) and PDF * ✅ **Fully Open-Source** — Apache 2.0 licensed -## Running using source code +## Running Presenton on Docker + +#### 1. Start Presenton + +##### Linux/MacOS (Bash/Zsh Shell): + +Run ```docker run -it --name presenton -p 3000:3000 -p 8000:8000 -v "./user_data:/app/user_data" ghcr.io/presenton/presenton:latest``` + +##### Windows (PowerShell): + +Run ```docker run -it --name presenton -p 3000:3000 -p 8000:8000 -v "${PWD}\user_data:/app/user_data" ghcr.io/presenton/presenton:latest``` + +#### 2. Open Presenton +Open http://localhost:3000 on browser of your choice to use Presenton. + + +## Running electron app using source code Before following these steps make sure [Poetry](https://python-poetry.org/docs/) is installed on your system.