Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,5 @@ jobs:
- name: Typecheck
run: bunx tsc --noEmit

- name: Python syntax check
run: python3 -m py_compile backend/pdfzen_backend.py
- name: Test
run: bun test
38 changes: 38 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Release

on:
push:
tags:
- "v*"

permissions:
contents: write

jobs:
release:
name: Build & Release
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Bun
uses: oven-sh/setup-bun@v2
with:
bun-version: latest

- name: Install dependencies
run: bun install --frozen-lockfile

- name: Install cross-platform native packages
run: bun add --no-save @opentui/core-darwin-arm64@0.1.74 @opentui/core-darwin-x64@0.1.74 @opentui/core-linux-arm64@0.1.74 @opentui/core-win32-x64@0.1.74

- name: Build all targets
run: bun run build:release

- name: Create GitHub Release
uses: softprops/action-gh-release@v2
with:
generate_release_notes: true
files: release/artifacts/pdfzen-*
9 changes: 2 additions & 7 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ node_modules
# output
out
dist
/release/*
/release/artifacts
/release/.build
*.tgz

# code coverage
Expand All @@ -24,7 +25,6 @@ report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
.env.local

# caches
.eslintcache
.cache
*.tsbuildinfo

Expand All @@ -34,10 +34,5 @@ report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
# Finder (MacOS) folder config
.DS_Store

# Python virtual environment
backend/.venv
__pycache__
*.pyc

# Agent skills
.agents
29 changes: 19 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,42 +6,51 @@

## Installation

### Quick install (macOS / Linux)

```bash
curl -fsSL https://raw.githubusercontent.com/viralcodex/pdfzen/main/install.sh | bash
```

### Windows

Download `pdfzen-windows-x64.exe` from the [latest release](https://github.com/viralcodex/pdfzen/releases/latest) and add it to your PATH.

### From source

Prerequisites:

- Bun (latest recommended)
- Python 3.10+

Install project dependencies:

```bash
bun install
```

## Setup

First-time setup (creates Python virtual environment and installs backend dependencies):
First-time setup (installs dependencies):

```bash
bun run setup
```

## Usage

Run the app (cross-platform):
Run the app:

```bash
bun run dev:all
bun run dev
```

Other commands:

```bash
bun run setup # Setup backend + frontend dependencies only
bun run dev:ui # Run UI only
bun run dev:backend # Run backend CLI
bun run setup # Install dependencies
bun run build # Build for distribution
bun run build:release # Build standalone binaries for all platforms
```

Install a global `pdfzen` command (macOS/Linux/Windows):
Install a global `pdfzen` command (macOS/Linux):

```bash
bun run install:global
Expand Down
Loading
Loading