docs(frontend): add getting started and dev instructions #1130
Conversation
📝 WalkthroughWalkthroughThis pull request updates the project's documentation by restructuring the root README with new Contributing and License sections, while also adding a comprehensive Getting Started guide to the frontend README with setup instructions and troubleshooting. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@frontend/README.md`:
- 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).
🧹 Nitpick comments (2)
frontend/README.md (2)
12-51: Use proper markdown headings instead of bold text.The subsection labels (
**Prerequisites**,**Install dependencies**, etc.) should use proper markdown headings (e.g.,###or####) instead of bold text. This improves document structure, navigation, and accessibility.📝 Suggested refactor to use proper headings
-**Prerequisites** +### 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** +### Install dependencies ```bash cd frontend npm install-Run the frontend development server
+### Run the frontend development servernpm run dev-Run the desktop app (Tauri) in development
+### Run the desktop app (Tauri) in developmentnpm run tauri dev-Build & preview
+### Build & previewnpm run build npm run preview-Useful scripts
+### Useful scripts
npm run test— run testsnpm run lint:check/npm run lint:fix— lintingnpm run format:check/npm run format:fix— formattingnpm run setup:linux— runscripts/setup_env.shto prepare the Linux dev environment-Troubleshooting
+### Troubleshooting</details> --- `16-16`: **Format the bare URL properly.** The Tauri URL should be wrapped in angle brackets or converted to a proper markdown link for better rendering and compliance with markdown best practices. <details> <summary>🔗 Suggested fix for URL formatting</summary> ```diff -- If you plan to run the desktop app with Tauri: Rust toolchain (install via `rustup`) and Tauri prerequisites — see https://tauri.app/ +- If you plan to run the desktop app with Tauri: Rust toolchain (install via `rustup`) and Tauri prerequisites — see <https://tauri.app/>Or use a proper link:
-- If you plan to run the desktop app with Tauri: Rust toolchain (install via `rustup`) and Tauri prerequisites — see https://tauri.app/ +- If you plan to run the desktop app with Tauri: Rust toolchain (install via `rustup`) and Tauri prerequisites — see the [Tauri prerequisites documentation](https://tauri.app/)
| - `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 |
There was a problem hiding this comment.
🧩 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.jsonRepository: 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).
1 participant
Summary
This pull request adds a Getting Started section to the frontend README.
The new section documents how to install dependencies and run the frontend in development and production modes, including Tauri desktop development.
Closing issue #1129
Summary by CodeRabbit