From 6601df3c82c860c3f86e1cf87798583301ed79ed Mon Sep 17 00:00:00 2001 From: marvan5111 Date: Sat, 28 Feb 2026 13:02:07 +0530 Subject: [PATCH] Add beginner-friendly Quick Start guide to README --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.md b/README.md index 595889480..be32cca69 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,40 @@ PictoPy is an advanced desktop gallery application that combines the power of Ta 1. First, join the **[Discord Server](https://discord.gg/hjUhu33uAn) (Go to Projects->PictoPy)** to chat with everyone. 2. For detailed setup instructions, coding guidelines, and the contribution process, please check out our [CONTRIBUTING.md](./CONTRIBUTING.md) file. +## Quick Start for Beginners 🚀 + +If you’re new to PictoPy or just starting with Python/Node projects, here’s the simplest way to get things running: + +1. **Clone the repository** +git clone https://github.com/marvan5111/PictoPy.git +cd PictoPy + +2. **Backend setup (Python)** +- Create a virtual environment: + - Windows: `python -m venv venv && venv\Scripts\activate` + - Linux/Mac: `python3 -m venv venv && source venv/bin/activate` +- Install dependencies: + ``` + pip install -r requirements.txt + ``` + +3. **Frontend setup (Node.js)** +- Navigate to the frontend folder: + ``` + cd frontend + ``` +- Install dependencies: + ``` + npm install + ``` + +4. **Run the project** +- Backend: `python app.py` (or the main backend entry file) +- Frontend: `npm start` + +💡 *Tip:* Beginners can start with just the backend first — it’s easier to test quickly. + + # Architecture