Skip to content

docs(frontend): add getting started and dev instructions #1130

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

Closed
Aditya30ag wants to merge 1 commit into from
Closed

docs(frontend): add getting started and dev instructions #1130

Show file tree
Hide file tree
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
16 changes: 12 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,16 @@

PictoPy is an advanced desktop gallery application that combines the power of Tauri, React, and Rust for the frontend with a Python backend for sophisticated image analysis and management.

# Want to Contribute? 😄
# Contributing

We welcome contributions of all kinds — code, documentation, tests, bug reports, and ideas. For full contribution guidelines, please read our [`CONTRIBUTING.md`](./CONTRIBUTING.md).

- **Chat & discuss:** Join our **[Discord Server](https://discord.gg/hjUhu33uAn)** (see Projects → PictoPy) to ask questions and propose changes.
- **Report issues:** Use GitHub Issues for bugs and feature requests.
- **Contribute code:** Fork the repo, create a descriptive branch (e.g., `feature/add-thing`), add tests and documentation, then open a Pull Request against `main`. Follow the coding standards and testing instructions in [`CONTRIBUTING.md`](./CONTRIBUTING.md).


&nbsp;&nbsp;&nbsp;<a href="https://discord.gg/hjUhu33uAn"><img src="https://github.com/user-attachments/assets/3ed93273-5055-4532-a524-87a337a4fbba" height="40"></a>

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.

# Architecture

Expand Down Expand Up @@ -63,3 +67,7 @@ Handles file system operations and provides a secure bridge between the frontend
---

Our Code of Conduct: [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)

## License

This project is licensed under the **GNU General Public License v3.0 (GPL-3.0)**. See the full license in [`LICENSE.md`](./LICENSE.md).
46 changes: 46 additions & 0 deletions frontend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,49 @@ This template should help get you started developing with Tauri, React and Types
## Recommended IDE Setup

- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
## Getting Started

Follow these steps to run the frontend locally.

**Prerequisites**

- Node.js (LTS) installed (recommended v18+)
- npm, pnpm, or yarn
- If you plan to run the desktop app with Tauri: Rust toolchain (install via `rustup`) and Tauri prerequisites — see https://tauri.app/

**Install dependencies**

```bash
cd frontend
npm install
```

**Run the frontend development server**

```bash
npm run dev
```

**Run the desktop app (Tauri) in development**

```bash
npm run tauri dev
```

**Build & preview**

```bash
npm run build
npm run preview
```

**Useful scripts**

- `npm run test` — run tests
- `npm run lint:check` / `npm run lint:fix` — linting
- `npm run format:check` / `npm run format:fix` — formatting
- `npm run setup:linux` — run `scripts/setup_env.sh` to prepare the Linux dev environment
Copy link
Contributor

@coderabbitai coderabbitai bot Feb 2, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

fd -t f "setup_env.sh" scripts/

Repository: AOSSIE-Org/PictoPy

Length of output: 44

🏁 Script executed:

ls -la scripts/ 2>/dev/null || echo "scripts/ directory not found"

Repository: AOSSIE-Org/PictoPy

Length of output: 542

🏁 Script executed:

grep -A 2 "setup:linux" frontend/package.json

Repository: AOSSIE-Org/PictoPy

Length of output: 259

Fix broken setup:linux command — the script setup_env.sh does not exist.

The npm script setup:linux in package.json references ./setup_env.sh, but this file does not exist in the scripts/ directory. The actual file is scripts/linux-dev.sh. Update both the package.json script definition and the README.md documentation to reference the correct script.

🤖 Prompt for AI Agents 
In `@frontend/README.md` at line 49, Update the broken setup command by changing
the npm script named "setup:linux" to invoke the correct script file (replace
references to ./setup_env.sh with scripts/linux-dev.sh) in package.json, and
update the README entry that currently shows `npm run setup:linux — run
scripts/setup_env.sh` to reference `scripts/linux-dev.sh` instead so both
package.json "setup:linux" and the README consistently point to the actual
script (linux-dev.sh).


**Troubleshooting**

- If `npm run tauri dev` fails, ensure you have Rust and the required toolchain installed (see Tauri docs). If the dev server doesn't start, check for port conflicts or errors in the terminal.
Loading