Skip to content

Add beginner-friendly Quick Start guide to README #1201

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
marvan5111 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add beginner-friendly Quick Start guide to README #1201

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Comment on lines +15 to +17
Copy link
Contributor

@coderabbitai coderabbitai bot Feb 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Use the canonical repository URL in clone instructions.

Line 16 currently points to a personal fork, which can misdirect new contributors and break expected upstream workflow. Please switch it to the main project repository URL.

Suggested fix 
- git clone https://github.com/marvan5111/PictoPy.git
+ git clone https://github.com/AOSSIE-Org/PictoPy.git
  cd PictoPy

As per coding guidelines, "Confirm that the code meets the project's requirements and objectives".

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
1. **Clone the repository**
git clone https://github.com/marvan5111/PictoPy.git
cd PictoPy
1. **Clone the repository**
git clone https://github.com/AOSSIE-Org/PictoPy.git
cd PictoPy
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 15 - 17, Replace the personal-fork clone URL in the
README's "Clone the repository" step (the git clone line that points to
marvan5111/PictoPy) with the project's canonical upstream repository URL so new
contributors clone the main project; update that single git clone line in the
README accordingly and keep the subsequent cd PictoPy step unchanged.


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
```
Comment on lines +24 to +36
Copy link
Contributor

@coderabbitai coderabbitai bot Feb 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Add language identifiers to fenced code blocks.

Lines 24, 30, and 34 use fenced blocks without a language, which triggers markdownlint (MD040). Use bash for command snippets.

Suggested fix 
-  ```
+  ```bash
   pip install -r requirements.txt

...

  • cd frontend

...

  • npm install
</details>

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 markdownlint-cli2 (0.21.0)</summary>

[warning] 24-24: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

[warning] 30-30: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

[warning] 34-34: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</details>

</details>

<details>
<summary>🤖 Prompt for AI Agents</summary>

Verify each finding against the current code and only fix it if needed.

In @README.md around lines 24 - 36, The fenced code blocks containing the shell
commands ("pip install -r requirements.txt", "cd frontend", and "npm install")
are missing language identifiers and trigger markdownlint MD040; update each
triple-backtick fence to use bash (i.e., change tobash) for those three
blocks so they are properly annotated as shell commands.


</details>

<!-- fingerprinting:phantom:triton:hawk -->

<!-- This is an auto-generated comment by CodeRabbit -->


4. **Run the project**
- Backend: `python app.py` (or the main backend entry file)
- Frontend: `npm start`
Comment on lines +38 to +40
Copy link
Contributor

@coderabbitai coderabbitai bot Feb 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

# First, let's see the repository structure and find the backend entry file
cd "$(git rev-parse --show-toplevel)" || exit
echo "=== Repository Structure ==="
git ls-files | head -30
echo ""
echo "=== Looking for backend entry files ==="
fd -type f '(app\.py|main\.py|pyproject\.toml|setup\.py|requirements\.txt)' . | head -20

Repository: AOSSIE-Org/PictoPy

Length of output: 1186

🏁 Script executed:

# Read the README.md around lines 38-40 to see the context
echo "=== README.md (lines 30-50) ==="
sed -n '30,50p' README.md

Repository: AOSSIE-Org/PictoPy

Length of output: 456

🏁 Script executed:

# Search for FastAPI or Flask app initialization and entry points
echo "=== Searching for app initialization patterns ==="
rg -l 'FastAPI|Flask|app\s*=|if __name__' --type py . | head -10

Repository: AOSSIE-Org/PictoPy

Length of output: 386

🏁 Script executed:

# Check for actual backend entry file
echo "=== Checking common entry points ==="
for file in app.py main.py backend.py server.py; do
  if [ -f "$file" ]; then
    echo "Found: $file"
    head -20 "$file"
    echo "---"
  fi
done

Repository: AOSSIE-Org/PictoPy

Length of output: 98

🏁 Script executed:

# Check for pyproject.toml or setup.py for entry points
echo "=== Checking pyproject.toml for entry points ==="
if [ -f "pyproject.toml" ]; then
  cat pyproject.toml
fi

Repository: AOSSIE-Org/PictoPy

Length of output: 110

🏁 Script executed:

# Search in backend directory if it exists
echo "=== Looking for backend-specific structure ==="
find . -type d -name 'backend' -o -type d -name 'server' -o -type d -name 'api' | head -5

Repository: AOSSIE-Org/PictoPy

Length of output: 152

🏁 Script executed:

# Read the backend main.py to understand the proper invocation
echo "=== backend/main.py (first 50 lines) ==="
head -50 backend/main.py

Repository: AOSSIE-Org/PictoPy

Length of output: 1831

🏁 Script executed:

# Check CONTRIBUTING.md for backend setup instructions
echo "=== CONTRIBUTING.md ==="
cat CONTRIBUTING.md

Repository: AOSSIE-Org/PictoPy

Length of output: 3065

🏁 Script executed:

# Look for any setup or startup scripts
echo "=== Searching for setup/startup documentation ==="
find . -type f \( -name 'SETUP.md' -o -name 'DEVELOPMENT.md' -o -name 'setup.py' -o -name 'Makefile' \) 2>/dev/null

Repository: AOSSIE-Org/PictoPy

Length of output: 111

🏁 Script executed:

# Check if there are any docker files or scripts that show how to run the backend
echo "=== Checking for docker or startup scripts ==="
find . -type f \( -name 'Dockerfile*' -o -name 'docker-compose*' -o -name '*.sh' \) | head -20

Repository: AOSSIE-Org/PictoPy

Length of output: 236

🏁 Script executed:

# Check the backend run.sh script to see proper invocation
echo "=== backend/run.sh ==="
cat backend/run.sh

Repository: AOSSIE-Org/PictoPy

Length of output: 875

🏁 Script executed:

# Also check if there are environment setup requirements
echo "=== backend/.gitignore or requirements.txt ==="
ls -la backend/ | grep -E "requirements|\.env|setup"

Repository: AOSSIE-Org/PictoPy

Length of output: 175

🏁 Script executed:

# Check for any README in backend directory
echo "=== backend directory contents ==="
ls -la backend/ | head -20

Repository: AOSSIE-Org/PictoPy

Length of output: 935

Update README backend startup command to use the actual entry point.

Line 39 documents python app.py which does not exist in this repository. The actual backend entry point is backend/main.py. Replace the ambiguous instruction with the correct command: cd backend && python main.py.

The fallback text "(or the main backend entry file)" is vague and will confuse beginners. Provide a single, verified command that actually works.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 38 - 40, Replace the incorrect and ambiguous backend
startup instruction "python app.py" with the verified command "cd backend &&
python main.py" in the README run section, and remove the fallback parenthetical
"(or the main backend entry file)" so the Backend line reads a single, working
command; locate the current entry under the "Run the project" section and update
that Backend line accordingly.


💡 *Tip:* Beginners can start with just the backend first — it’s easier to test quickly.



# Architecture

Expand Down