feat: Add MIT license and replace README with comprehensive project documentation.

This commit is contained in:
2026-01-30 15:00:00 +01:00
parent 76198f28c5
commit 1e87e7d2ea
2 changed files with 63 additions and 61 deletions

103
README.md
View File

@@ -1,75 +1,56 @@
# React + TypeScript + Vite
# K-Convert
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
A privacy-first file converter that runs entirely in your browser using WebAssembly. No uploads, no servers—your files never leave your device.
Currently, two official plugins are available:
## Features
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
- **100% Client-Side** — All conversions happen locally using WASM
- **Image Conversion** — JPEG, PNG, WebP, GIF, BMP, TIFF, HEIC, ICO, AVIF, JXL, SVG, PSD, RAW, TGA
- **Audio Conversion** — MP3, WAV, OGG, M4A, FLAC, AAC, AIFF, ALAC, WMA, Opus, M4R, AMR
- **Drag & Drop** — Simple file upload with batch support
- **Progress Tracking** — Real-time conversion progress
- **Dark Mode** — Beautiful dark theme enabled by default
## React Compiler
## Tech Stack
The React Compiler is enabled on this template. See [this documentation](https://react.dev/learn/react-compiler) for more information.
- **Frontend:** React + TypeScript + Vite
- **UI:** Shadcn UI + Tailwind CSS
- **Image Processing:** [ImageMagick WASM](https://github.com/dlemstra/magick-wasm)
- **Audio Processing:** [FFmpeg WASM](https://github.com/nicholasrobinson/ffmpegwasm/ffmpeg.wasm)
- **HEIC Support:** [heic2any](https://github.com/nicholasrobinson/heic2any)
Note: This will impact Vite dev & build performances.
## Getting Started
## Expanding the ESLint configuration
```bash
# Install dependencies
npm install
If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
# Start development server
npm run dev
```js
export default defineConfig([
globalIgnores(['dist']),
{
files: ['**/*.{ts,tsx}'],
extends: [
// Other configs...
// Remove tseslint.configs.recommended and replace with this
tseslint.configs.recommendedTypeChecked,
// Alternatively, use this for stricter rules
tseslint.configs.strictTypeChecked,
// Optionally, add this for stylistic rules
tseslint.configs.stylisticTypeChecked,
// Other configs...
],
languageOptions: {
parserOptions: {
project: ['./tsconfig.node.json', './tsconfig.app.json'],
tsconfigRootDir: import.meta.dirname,
},
// other options...
},
},
])
# Build for production
npm run build
```
You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
## Architecture
```js
// eslint.config.js
import reactX from 'eslint-plugin-react-x'
import reactDom from 'eslint-plugin-react-dom'
The app uses a Worker-Broker model for efficient processing:
export default defineConfig([
globalIgnores(['dist']),
{
files: ['**/*.{ts,tsx}'],
extends: [
// Other configs...
// Enable lint rules for React
reactX.configs['recommended-typescript'],
// Enable lint rules for React DOM
reactDom.configs.recommended,
],
languageOptions: {
parserOptions: {
project: ['./tsconfig.node.json', './tsconfig.app.json'],
tsconfigRootDir: import.meta.dirname,
},
// other options...
},
},
])
```
Main Thread (UI) ←→ ConversionBroker ←→ Web Workers (WASM)
```
- **Image Worker** — Handles all image conversions via ImageMagick WASM
- **Audio Worker** — Handles all audio conversions via FFmpeg WASM
- **Adapters** — Clean abstractions for each conversion type
## Browser Requirements
Requires a modern browser with:
- WebAssembly support
- Web Workers
- SharedArrayBuffer (for FFmpeg)
## License
MIT License - see [LICENSE](LICENSE) for details.