Skip to content

docs: add How it works section explaining the JSS wrapper split #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
melvincarvalho wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add How it works section explaining the JSS wrapper split #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,25 @@

**servejss** is `serve` with superpowers: same simple interface, but you can write too.

## How it works

servejss doesn't serve anything itself — it's a thin launcher for
[JSS](https://github.com/JavaScriptSolidServer/JavaScriptSolidServer).
It translates `serve`-style flags into a `jss start` invocation, points it
at your directory in `--public` mode (no auth, WAC skipped), picks a free
port, prints the banner, and manages the child process. Every request is
handled by JSS.

In practice that split means:

- **servejss owns** the CLI, the serve-a-directory defaults (public mode,
live reload, git backend), port auto-switching, and the startup UX
- **JSS owns** everything about actual serving: GET/PUT/DELETE handling,
ETags and conditional requests, the git HTTP backend, and all Solid
protocol features — so issues about request behavior belong upstream
- `--solid` drops the public default and starts JSS as a full
authenticated Solid server (Solid-OIDC + WAC)

## Install

```bash
Expand Down