Sporades User Guide

Build, run, inspect, and publish a Sporades Capsule. This guide starts with the shortest useful path, then branches by what you want to accomplish.

If Sporades is not installed yet, install the package globally:

npm install --global sporades

Get a Capsule running

sporades create notes --template todo
cd notes
sporades dev

Open the URL printed by sporades dev. Edit server/, client/, or shared/; the Dev session rebuilds the Capsule and refreshes the browser.

Follow Build your first Capsule for the complete Todo walkthrough from server schema to client mutation and local Container.

When it works in development, try the same Bundle in a local Container session:

sporades deploy --port 5000

That is the complete starting loop. Everything below extends it.

Walkthrough

Build the Capsule

• Understand the project and choose a framework
• Build server behaviour
• Build the browser client
• Add authentication
• Upload and publish files
• Add realtime activity or App messages
• Run Jobs and Schedules
• Configure security, Server env, preferences, and services

Run and publish it

• Inspect and operate local sessions
• Publish and operate Hosted Capsules
• Troubleshoot a Capsule

Look something up

• Detailed feature and command reference
• SDK documentation
• Generated API reference
• Architecture
• Runtime layout

How the pieces fit together

server/index.ts defines schema and server behaviour. The configured client entry builds the browser UI. shared/ holds portable types and helpers. sporades.json declares Capsule configuration. Sporades owns .sporades/, which contains replaceable Bundles and persistent local runtime state.

Dev sessions favour iteration speed. Local Container sessions run the same Bundle in Docker. Hosted Capsules run a pushed release on a configured Host server. Move through those environments in that order unless you have a good reason not to—production is a rather expensive syntax checker. 🙂