feat: Transform to Tauri desktop app
- Initialize Tauri v2 project with Rust backend - Restructure project: move source files to src/ directory - Add Tauri configuration for Windows, macOS, and Linux builds - Update Vite config for Tauri development workflow - Add file system and dialog permissions for native features - Update package.json with desktop build scripts - Update tsconfig.json paths for new src structure - Add Tauri and desktop badges to README - Document desktop build process and architecture
This commit is contained in:
71
README.md
71
README.md
@@ -18,6 +18,11 @@
|
||||
<img src="https://img.shields.io/badge/TypeScript-5.8-3178C6?style=for-the-badge&logo=typescript&logoColor=white" alt="TypeScript" />
|
||||
<img src="https://img.shields.io/badge/Vite-6-646CFF?style=for-the-badge&logo=vite&logoColor=white" alt="Vite" />
|
||||
<img src="https://img.shields.io/badge/Tailwind-3-06B6D4?style=for-the-badge&logo=tailwindcss&logoColor=white" alt="Tailwind" />
|
||||
<img src="https://img.shields.io/badge/Tauri-2-24C8D8?style=for-the-badge&logo=tauri&logoColor=white" alt="Tauri" />
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<img src="https://img.shields.io/badge/Desktop_App-Windows%20%7C%20macOS%20%7C%20Linux-blue?style=for-the-badge" alt="Desktop Apps" />
|
||||
</p>
|
||||
|
||||
<p>
|
||||
@@ -71,6 +76,7 @@ In a world where document formatting tools are increasingly locked behind paywal
|
||||
- **🎨 40+ Typography Styles** — Curated across 8 aesthetic categories
|
||||
- **📐 Multiple Paper Sizes** — A4 and Letter formats supported
|
||||
- **💾 Local Processing** — Your documents never leave your machine
|
||||
- **🖥️ Native Desktop Apps** — Built with Tauri for Windows, macOS, and Linux
|
||||
- **📥 One-Click Export** — Clean `.docx` files ready for Microsoft Word
|
||||
|
||||
### 🏛️ Style Categories
|
||||
@@ -140,13 +146,22 @@ Every style includes meticulously configured:
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### Prerequisites
|
||||
### Option 1: Download Desktop App (Recommended)
|
||||
|
||||
Pre-built binaries coming soon for:
|
||||
- 🪟 **Windows** (.msi, .exe)
|
||||
- 🍎 **macOS** (.dmg, .app)
|
||||
- 🐧 **Linux** (.deb, .rpm, .AppImage)
|
||||
|
||||
### Option 2: Build from Source
|
||||
|
||||
#### Prerequisites
|
||||
|
||||
- **Node.js** 18+ (we recommend the latest LTS)
|
||||
- A modern web browser
|
||||
- **Rust** (for Tauri desktop builds)
|
||||
- Your favorite text editor
|
||||
|
||||
### Installation
|
||||
#### Web Development
|
||||
|
||||
```bash
|
||||
# 1. Clone the collective's work
|
||||
@@ -164,6 +179,18 @@ npm run dev
|
||||
|
||||
Your browser will open to `http://localhost:3000` — and you're ready to create!
|
||||
|
||||
#### Desktop App Development
|
||||
|
||||
```bash
|
||||
# Run in desktop development mode
|
||||
npm run desktop
|
||||
|
||||
# Build desktop app for production
|
||||
npm run desktop:build
|
||||
```
|
||||
|
||||
The built apps will be in `src-tauri/target/release/bundle/`
|
||||
|
||||
### Usage
|
||||
|
||||
1. **📤 Upload** — Drag and drop your Markdown file (or click to browse)
|
||||
@@ -301,25 +328,37 @@ This follows established typographic best practices for comfortable reading.
|
||||
### Available Scripts
|
||||
|
||||
```bash
|
||||
# Development server with hot reload
|
||||
npm run dev
|
||||
# Web Development
|
||||
npm run dev # Start Vite dev server
|
||||
npm run build # Production build (outputs to dist/)
|
||||
npm run preview # Preview production build locally
|
||||
|
||||
# Production build (outputs to dist/)
|
||||
npm run build
|
||||
|
||||
# Preview production build locally
|
||||
npm run preview
|
||||
# Desktop App Development (Tauri)
|
||||
npm run desktop # Run desktop app in dev mode
|
||||
npm run desktop:build # Build desktop app for production
|
||||
npm run tauri # Access Tauri CLI directly
|
||||
```
|
||||
|
||||
### Project Structure
|
||||
|
||||
```
|
||||
typogenie/
|
||||
├── 📁 components/ # React components
|
||||
│ ├── FileUpload.tsx # Drag-and-drop upload zone
|
||||
│ ├── StyleSelector.tsx # Style gallery with live preview
|
||||
│ ├── Preview.tsx # Final preview & DOCX export
|
||||
│ └── StylePreviewModal.tsx # (Optional) Modal preview
|
||||
├── 📁 src/ # Source code
|
||||
│ ├── 📁 components/ # React components
|
||||
│ │ ├── FileUpload.tsx # Drag-and-drop upload zone
|
||||
│ │ ├── StyleSelector.tsx # Style gallery with live preview
|
||||
│ │ ├── Preview.tsx # Final preview & DOCX export
|
||||
│ │ └── StylePreviewModal.tsx # (Optional) Modal preview
|
||||
│ ├── 📁 styles/ # Typography style definitions
|
||||
│ ├── 📄 main.tsx # React entry point
|
||||
│ ├── 📄 App.tsx # Main application component
|
||||
│ ├── 📄 types.ts # TypeScript interfaces
|
||||
│ └── 📄 constants.ts # Configuration exports
|
||||
├── 📁 src-tauri/ # Tauri desktop app
|
||||
│ ├── 📁 src/ # Rust source code
|
||||
│ ├── 📁 icons/ # App icons
|
||||
│ ├── 📄 Cargo.toml # Rust dependencies
|
||||
│ └── 📄 tauri.conf.json # Tauri configuration
|
||||
├── 📁 styles/ # Typography style definitions
|
||||
│ ├── index.ts # Aggregates all categories
|
||||
│ ├── minimalist.ts # 11 clean styles
|
||||
@@ -352,6 +391,8 @@ typogenie/
|
||||
| **Icons** | Lucide React | Beautiful, consistent iconography |
|
||||
| **Markdown** | marked 12.0.0 | Local Markdown parsing |
|
||||
| **Documents** | docx 8.5.0 | Client-side DOCX generation |
|
||||
| **Desktop** | Tauri 2.0 | Native desktop apps (Rust + WebView) |
|
||||
| **Backend** | Rust 1.77+ | Systems programming for desktop shell |
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user