Strudel Server 🌀

A lightweight, Playwright-based server with file-watching capabilities for seamless development of Strudel projects using your preferred text editor.

demo.mp4

Motivation

While Strudel does have its own REPL CodeMirror editor, strudel-server allows you to work on a Strudel project in your favorite text editor and have the server automatically reload the project when you save changes.

While I'm working on a Strudel project in my editor, I can run the server in the background and have it automatically reload the project when I save changes.

Installation 📦

Prerequisites

• Bun v1.2.0+ (required)
• Node.js v16+ (for Playwright compatibility)

Local

1. Clone this repository

git clone https://github.com/micahkepe/strudel-server.git
cd strudel-server

2. Install dependencies

bun install

3. Run the server

bun run start

Global

To install the strudel-server binary globally:

bun link

Then run the server from anywhere with strudel-server with:

strudel-server <file>

Usage

Workflow:

1. Open a Strudel project in your favorite text editor.
2. Run the server with bun run src/main.ts <file> (or strudel-server <file> if you installed the binary globally).
3. Save changes in your editor, and the server will automatically reload the project.

CLI usage:

Usage: strudel-server [options] <file>

<file> is the path to a file to watch for changes.

Options:
  -h, --help       Show this help message and exit
  -v, -vv, -vvv    Set logging verbosity (default: info)

Examples:
  strudel-server ~/my-project/song.strudel
  strudel-server -v ~/my-project/song.strudel

License

This project is licensed under the MIT License - see the LICENSE file for details.