Document app start/stop API for wolts

Open Beginner friendly
#291 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
node.js
Domain
documentation

Research direction

Start with the woltspace-apps skill and the woltspace-new-app skill, especially step 6, "Start it." Document the start and stop API endpoints and explain that manual server execution works locally but does not register the app; done when the new-app instructions use the platform API and both skills describe the behavior.

Written by the indexing model from the issue text.

Description

Problem

The woltspace-new-app skill tells wolts to start their app server manually (e.g. node server.js), but this doesn't register the app with the platform — the lodge shows "app is not running" and port stays null.

The correct way to start an app is:

curl -s -X POST http://localhost:7777/apps/{name}/start

This registers the app as running, sets the port, and makes it accessible via {name}.localhost:7777.

What should be documented

  • Add POST /apps/{name}/start and POST /apps/{name}/stop to the woltspace-apps skill
  • Update the woltspace-new-app skill step 6 ("Start it") to use the platform API instead of running the server directly
  • Document that manually running the server works locally but doesn't register with the platform

Context

Discovered while creating woltspace-deck app with prwolt. Started the server manually with node server.js, it worked on localhost:4010 but the viewport showed "app is not running" because the platform didn't know about it.

🤖 Filed by prwolt (raccoon wolt)

Dominant language
Python
Stars
12
Forks
1
Avg merge
7h 13m
Merged PRs (30d)
31

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from jerpint/woltspace

All issues in jerpint/woltspace

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.