Skip to content

Development Setup

Nick edited this page Jul 28, 2026 · 1 revision

Development Setup

Prerequisites

Tool Version Install
Windows 10 or 11
Python 3.11+ python.org
Node.js 18+ nodejs.org
Rust latest rustup.rs
uv latest pip install uv or standalone installer

Clone

git clone https://github.com/Open-Write/open-write-studio.git
cd open-write-studio

Install Dependencies

Backend (Python):

cd backend
uv sync --dev

Frontend (Node):

cd app
npm install

Run in Development

Open two terminals from the repo root:

# Terminal 1 — Backend
cd backend
uv run uvicorn app.main:app --reload --port 8000
# Terminal 2 — Frontend + Tauri shell
cd app
npm run tauri dev

The Tauri window opens at http://localhost:1420 (Vite dev server) with hot reload. The backend runs at http://127.0.0.1:8000.

Dev mode does not use the sidecar. The backend must be running manually. The bundled Python .exe is only built for release.

PowerShell Notes

PowerShell execution policy blocks .ps1 scripts. Use these workarounds:

  • Use npm.cmd instead of npm for npm commands
  • Run .ps1 scripts via powershell -ExecutionPolicy Bypass -File <script>

IDE Setup

The project uses strict TypeScript (noUnusedLocals + noUnusedParameters). Any edit that leaves an unused import or local will fail tsc.

  • Frontend: React 19 + TypeScript + Vite + Tailwind CSS v4
  • Backend: Python + FastAPI + uv
  • Editor config: .editorconfig for consistent formatting across editors

Clone this wiki locally