|
1 | | -# React + TypeScript + Vite |
| 1 | +<div align="center"> |
2 | 2 |
|
3 | | -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. |
| 3 | +# PictoPy Website |
4 | 4 |
|
5 | | -Currently, two official plugins are available: |
| 5 | +The official landing page for **[PictoPy](https://github.com/AOSSIE-Org/PictoPy)** — a privacy-first, AI-powered desktop image gallery. |
6 | 6 |
|
7 | | -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh |
8 | | -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh |
| 7 | +[](https://github.com/AOSSIE-Org/PictoPy-Website/actions/workflows/build-and-deploy.yaml) |
| 8 | +[](LICENSE) |
9 | 9 |
|
10 | | -## Expanding the ESLint configuration |
| 10 | +**[pictopy.aossie.org](https://pictopy.aossie.org)** · [PictoPy App Repo](https://github.com/AOSSIE-Org/PictoPy) · [Discord](https://discord.gg/hjUhu33uAn) |
11 | 11 |
|
12 | | -If you are developing a production application, we recommend updating the configuration to enable type aware lint rules: |
| 12 | +</div> |
13 | 13 |
|
14 | | -- Configure the top-level `parserOptions` property like this: |
| 14 | +--- |
15 | 15 |
|
16 | | -```js |
17 | | -export default tseslint.config({ |
18 | | - languageOptions: { |
19 | | - // other options... |
20 | | - parserOptions: { |
21 | | - project: ['./tsconfig.node.json', './tsconfig.app.json'], |
22 | | - tsconfigRootDir: import.meta.dirname, |
23 | | - }, |
24 | | - }, |
25 | | -}) |
| 16 | +## About PictoPy |
| 17 | + |
| 18 | +PictoPy is an advanced desktop gallery application that combines **Tauri**, **React**, and **Rust** for the frontend with a **Python** backend for sophisticated AI-powered image analysis and management. |
| 19 | + |
| 20 | +It runs entirely offline, keeping your photos and their analysis private — no cloud uploads, no external servers. |
| 21 | + |
| 22 | +### Key Features |
| 23 | + |
| 24 | +- **Smart Auto-Tagging** — automatically tags photos based on detected objects and recognized faces using YOLOv11 and FaceNet |
| 25 | +- **Face Clustering** — groups photos by person using DBSCAN clustering on face embeddings |
| 26 | +- **Smart Search** — find photos by objects, faces, or metadata instantly |
| 27 | +- **Album Management** — full traditional gallery features alongside AI capabilities |
| 28 | +- **Privacy-First** — fully offline, all processing happens locally on your machine |
| 29 | +- **Cross-Platform** — runs on Windows, macOS, and Linux via Tauri |
| 30 | + |
| 31 | +### Tech Stack |
| 32 | + |
| 33 | +| Layer | Technology | |
| 34 | +|---|---| |
| 35 | +| Desktop Framework | Tauri | |
| 36 | +| Frontend | React, TypeScript, Tailwind CSS | |
| 37 | +| Rust Backend | Rust (file system & Tauri bridge) | |
| 38 | +| Python Backend | FastAPI, Python | |
| 39 | +| Object Detection | YOLOv11 | |
| 40 | +| Face Recognition | FaceNet, ONNX Runtime | |
| 41 | +| Face Clustering | DBSCAN | |
| 42 | +| Database | SQLite | |
| 43 | +| Image Processing | OpenCV | |
| 44 | +| State Management | Redux Toolkit | |
| 45 | + |
| 46 | +--- |
| 47 | + |
| 48 | +## About This Repo |
| 49 | + |
| 50 | +This repository contains the **marketing website** for PictoPy, built with React, Vite, and Tailwind CSS. It is automatically deployed to [pictopy.aossie.org](https://pictopy.aossie.org) via GitHub Pages on every push to `main`. |
| 51 | + |
| 52 | +### Local Development |
| 53 | + |
| 54 | +```bash |
| 55 | +# Install dependencies |
| 56 | +npm install |
| 57 | + |
| 58 | +# Start the dev server |
| 59 | +npm run dev |
| 60 | + |
| 61 | +# Production build |
| 62 | +npm run build |
26 | 63 | ``` |
27 | 64 |
|
28 | | -- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked` |
29 | | -- Optionally add `...tseslint.configs.stylisticTypeChecked` |
30 | | -- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config: |
31 | | - |
32 | | -```js |
33 | | -// eslint.config.js |
34 | | -import react from 'eslint-plugin-react' |
35 | | - |
36 | | -export default tseslint.config({ |
37 | | - // Set the react version |
38 | | - settings: { react: { version: '18.3' } }, |
39 | | - plugins: { |
40 | | - // Add the react plugin |
41 | | - react, |
42 | | - }, |
43 | | - rules: { |
44 | | - // other rules... |
45 | | - // Enable its recommended rules |
46 | | - ...react.configs.recommended.rules, |
47 | | - ...react.configs['jsx-runtime'].rules, |
48 | | - }, |
49 | | -}) |
| 65 | +The dev server runs at `http://localhost:5173`. |
| 66 | + |
| 67 | +### Project Structure |
| 68 | + |
50 | 69 | ``` |
| 70 | +src/ |
| 71 | +├── Pages/ |
| 72 | +│ ├── Landing page/ # Hero section & Navbar |
| 73 | +│ ├── Demo/ # Interactive demo marquee |
| 74 | +│ ├── HowItWorks/ # How It Works section |
| 75 | +│ ├── FaqPage/ # FAQ section |
| 76 | +│ ├── Footer/ # Footer |
| 77 | +│ └── pictopy-landing.tsx |
| 78 | +├── components/ |
| 79 | +│ └── ui/ # Reusable UI components |
| 80 | +├── context/ |
| 81 | +│ └── theme-provider.tsx |
| 82 | +└── lib/ |
| 83 | + └── utils.ts |
| 84 | +``` |
| 85 | + |
| 86 | +### Deployment |
| 87 | + |
| 88 | +Pushes to `main` trigger the [GitHub Actions workflow](.github/workflows/build-and-deploy.yaml), which builds the site and deploys it to GitHub Pages at [pictopy.aossie.org](https://pictopy.aossie.org). |
| 89 | + |
| 90 | +--- |
| 91 | + |
| 92 | +## Contributing |
| 93 | + |
| 94 | +We welcome contributions to the website! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) guide before submitting a PR. |
| 95 | + |
| 96 | +For contributions to the PictoPy application itself, visit the [main repository](https://github.com/AOSSIE-Org/PictoPy) and join the [Discord server](https://discord.gg/hjUhu33uAn). |
| 97 | + |
| 98 | +## License |
| 99 | + |
| 100 | +This project is licensed under the [GPL-3.0 License](LICENSE). |
0 commit comments