55 lines
1.4 KiB
Markdown
55 lines
1.4 KiB
Markdown
# Web Utils 2026
|
|
|
|
A privacy-focused, client-side first collection of web utilities.
|
|
|
|
## Overview
|
|
**Web Utils 2026** is designed to handle most operations directly in the browser to ensure data privacy and speed. The server is used only for heavy computations or platform-specific tasks (like image processing).
|
|
|
|
## Features
|
|
- **Client-Side First:** Logic for data generation and simple processing runs in the browser.
|
|
- **Stateless Backend:** No user sessions or persistent data storage.
|
|
- **Auto-Cleanup:** Temporary files for processing are automatically deleted.
|
|
- **Dynamic Registry:** Tool discovery via backend API.
|
|
|
|
## Tech Stack
|
|
|
|
### Frontend
|
|
- **Framework:** Vue 3 (Composition API) + TypeScript
|
|
- **Styling:** Tailwind CSS
|
|
- **Build:** Vite
|
|
|
|
### Backend
|
|
- **Framework:** FastAPI (Python)
|
|
- **Scheduler:** APScheduler (for cleanup)
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
- Node.js (v18+) or Bun
|
|
- Python 3.10+
|
|
|
|
### Backend Setup
|
|
```bash
|
|
cd backend
|
|
python -m venv venv
|
|
source venv/bin/activate # On Windows: venv\Scripts\activate
|
|
pip install -r requirements.txt
|
|
|
|
# Run server
|
|
uvicorn app.main:app --reload --host 0.0.0.0 --port 8000
|
|
```
|
|
|
|
### Frontend Setup
|
|
```bash
|
|
cd frontend
|
|
npm install
|
|
|
|
# Run development server
|
|
npm run dev
|
|
```
|
|
|
|
## Project Structure
|
|
- `backend/`: FastAPI server and tool implementations.
|
|
- `frontend/`: Vue 3 application source code.
|
|
- `PROJECT_RULES.md`: Core development guidelines.
|