Skip to content

Commit 6509246

Browse files
committed
docs(frontend): add getting started and dev instructions
1 parent c1a4ce9 commit 6509246

File tree

2 files changed

+58
-4
lines changed

2 files changed

+58
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,16 @@
22

33
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.
44

5-
# Want to Contribute? 😄
5+
# Contributing
6+
7+
We welcome contributions of all kinds — code, documentation, tests, bug reports, and ideas. For full contribution guidelines, please read our [`CONTRIBUTING.md`](./CONTRIBUTING.md).
8+
9+
- **Chat & discuss:** Join our **[Discord Server](https://discord.gg/hjUhu33uAn)** (see Projects → PictoPy) to ask questions and propose changes.
10+
- **Report issues:** Use GitHub Issues for bugs and feature requests.
11+
- **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).
12+
613

7-
&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>
814

9-
1. First, join the **[Discord Server](https://discord.gg/hjUhu33uAn) (Go to Projects->PictoPy)** to chat with everyone.
10-
2. For detailed setup instructions, coding guidelines, and the contribution process, please check out our [CONTRIBUTING.md](./CONTRIBUTING.md) file.
1115

1216
# Architecture
1317

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

6569
Our Code of Conduct: [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)
70+
71+
## License
72+
73+
This project is licensed under the **GNU General Public License v3.0 (GPL-3.0)**. See the full license in [`LICENSE.md`](./LICENSE.md).

frontend/README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,49 @@ This template should help get you started developing with Tauri, React and Types
55
## Recommended IDE Setup
66

77
- [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)
8+
## Getting Started
9+
10+
Follow these steps to run the frontend locally.
11+
12+
**Prerequisites**
13+
14+
- Node.js (LTS) installed (recommended v18+)
15+
- npm, pnpm, or yarn
16+
- If you plan to run the desktop app with Tauri: Rust toolchain (install via `rustup`) and Tauri prerequisites — see https://tauri.app/
17+
18+
**Install dependencies**
19+
20+
```bash
21+
cd frontend
22+
npm install
23+
```
24+
25+
**Run the frontend development server**
26+
27+
```bash
28+
npm run dev
29+
```
30+
31+
**Run the desktop app (Tauri) in development**
32+
33+
```bash
34+
npm run tauri dev
35+
```
36+
37+
**Build & preview**
38+
39+
```bash
40+
npm run build
41+
npm run preview
42+
```
43+
44+
**Useful scripts**
45+
46+
- `npm run test` — run tests
47+
- `npm run lint:check` / `npm run lint:fix` — linting
48+
- `npm run format:check` / `npm run format:fix` — formatting
49+
- `npm run setup:linux` — run `scripts/setup_env.sh` to prepare the Linux dev environment
50+
51+
**Troubleshooting**
52+
53+
- 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.

0 commit comments

Comments
 (0)