Run the local preview

The browser demo works immediately on this website. The GitHub workspace requires the separate project checkout, a Vue development server and a Laravel backend. It is currently a local, single-operator development build, not a hosted team service or a supported Docker release.

Restart an existing installation

On a machine where this project has already been installed, open two terminals in the project root. In the first, run:

npm run dev -- --port 5173 --strictPort

In the second, run:

npm run dev:backend

Keep both terminals open. Visit http://127.0.0.1:5173/?workspace=github in your browser. The editor forwards its API requests to Laravel on port 8000. If you see Retry connection, check that the backend terminal is still running.

Set up a fresh checkout

The project currently requires source access. There is no public installer or one-click hosted account. Installation details for a fresh checkout are in the project’s docs/github-workspace.md guide.

The tested stack uses Node 22.12 or newer, PHP 8.5, Composer 2 and SQLite. Install frontend and backend dependencies, configure a new Laravel environment and application key, and run migrations as described in that guide. Fresh-install steps are different from a restart.

Keep your existing data

Do not replace an existing .env, database or application key when restarting. The key decrypts stored GitHub credentials. Back up the database together with the environment key, and protect both as sensitive data.

Acknowledged repository drafts live in the backend database. The browser demo’s documents live only in tab memory. These are different storage models.

Current access boundary

Keep the development servers on loopback. There are no application accounts, team permissions or company isolation yet, so exposing this build as a public or shared service is outside its supported scope.

For the current workflow, continue with Connect your GitHub docs. Production installation and account documentation will be added when those features exist.