Skip to content

Commit ed2473c

Browse files
committed
📝 docs(setup): add interactive setup wizard documentation and fix type safety
- Add setup wizard documentation to README and CONTRIBUTING - Document ./setup.sh (Linux/macOS) and .\setup.ps1 (Windows) - Add non-interactive script options (--minimal, --docker-only) - Document start scripts with --dev, --prod, --docker, --no-ui flags - Link to new SETUP.md guide in README table of contents - Fix type safety in optional dependency imports across core and gateway - audio-tools: add Music
1 parent 9f6425a commit ed2473c

11 files changed

Lines changed: 1170 additions & 29 deletions

File tree

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,14 @@ Thank you for your interest in contributing to OwnPilot! This document provides
1414
### Getting Started
1515

1616
```bash
17+
# Clone and run interactive setup (recommended)
1718
git clone https://github.com/ownpilot/ownpilot.git
1819
cd ownpilot
20+
./setup.sh # Linux/macOS
21+
# or
22+
.\setup.ps1 # Windows PowerShell
23+
24+
# Or manually:
1925
pnpm install
2026
cp .env.example .env
2127
# Edit .env with your PostgreSQL connection details

README.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Privacy-first personal AI assistant platform with soul agents, autonomous backgr
1717
- [Features](#features)
1818
- [Architecture](#architecture)
1919
- [Quick Start](#quick-start)
20+
- [Setup Guide](SETUP.md) — Detailed installation instructions
2021
- [Project Structure](#project-structure)
2122
- [Packages](#packages)
2223
- [Core](#core-ownpilotcore)
@@ -308,7 +309,39 @@ docker compose --profile postgres up -d
308309
- **pnpm** >= 10.0.0
309310
- **PostgreSQL** 16+ (via Docker Compose or native install)
310311

311-
#### Setup
312+
#### Automated Setup (Recommended)
313+
314+
Use the interactive setup wizard:
315+
316+
```bash
317+
# Linux/macOS
318+
./setup.sh
319+
320+
# Windows PowerShell
321+
.\setup.ps1
322+
```
323+
324+
The wizard will guide you through:
325+
- Prerequisites check (Node.js, pnpm, Docker)
326+
- Server configuration (ports, host)
327+
- Authentication setup
328+
- Database configuration
329+
- Docker PostgreSQL startup
330+
- Dependency installation and build
331+
332+
**Alternative: Non-interactive scripts**
333+
334+
```bash
335+
# Linux/macOS
336+
./scripts/setup.sh --minimal # Skip Docker
337+
./scripts/setup.sh --docker-only # Only database
338+
339+
# Windows PowerShell
340+
.\scripts\setup.ps1 -Mode Minimal
341+
.\scripts\setup.ps1 -Mode DockerOnly
342+
```
343+
344+
#### Manual Setup
312345

313346
```bash
314347
# Clone and install
@@ -1663,6 +1696,21 @@ pnpm --filter @ownpilot/gateway start
16631696
### Scripts
16641697

16651698
```bash
1699+
# Setup wizard (interactive)
1700+
./setup.sh # Linux/macOS
1701+
.\setup.ps1 # Windows PowerShell
1702+
1703+
# Start scripts
1704+
./start.sh # Linux/macOS
1705+
.\start.ps1 # Windows PowerShell
1706+
1707+
# Start options:
1708+
# --dev Development mode with hot reload (default)
1709+
# --prod Production mode (build & serve)
1710+
# --docker Start with Docker Compose
1711+
# --no-ui Gateway only, without UI
1712+
1713+
# Package scripts
16661714
pnpm dev # Watch mode for all packages
16671715
pnpm build # Build all packages
16681716
pnpm test # Run all tests

0 commit comments

Comments
 (0)