Documentation

Download your codebase

Get your ZIP, run the app locally, and start making it yours.

Updated October 9, 2026.

Download the ZIP

Open a project from your dashboard and select Download .zip. You must be signed in to the account that created it and have lifetime access: a $999 one-time purchase or an active site administrator role. You can download it again from the same project page.

The archive contains a folder named after your project's slug. The project name, package name, and setup examples are renamed for you. Your hosting, Blog, Docs, JSON API, Stripe, Sentry, and PostHog choices are applied to the generated codebase.

Run it locally

Install Rust and Docker, then extract the archive. For a project with the slug acme-app:

unzip acme-app.zip
cd acme-app
docker compose up -d
cp .env.example .env
SQLX_OFFLINE=true cargo run

Open localhost:3000. The app connects to the local Postgres container and applies its migrations at startup. The first build uses SQLX_OFFLINE=true because the database has no tables until then; afterwards plain cargo run checks your queries against it. Keep Docker running while you work.

Sign up locally, then configure email for production

Signup works right away. With no mail provider configured, the app prints every email it would send, the six-character verification code included, to the terminal running cargo run. Enter that code in the browser to create the first account and session. This console mode only starts on a non-HTTPS SITE_URL.

Before deploying, configure MAILGUN_SENDING_KEY, MAILGUN_DOMAIN, MAIL_FROM, and an independent random EMAIL_VERIFICATION_KEY of at least 32 characters, following the generated README. Use your own Mailgun domain and credentials; ShipRust does not include them in the ZIP. With the Mailgun values missing on an HTTPS origin the app refuses to start; partial settings prevent startup too. The generated email-verification guide has the setup details when Docs is enabled.

To follow the implementation, read the email verification and session walkthrough. It explains which state lives in Postgres, how code attempts are limited, and where to add your application's authorization checks.

Make it yours

Read README.md for setup details and AGENTS.md for development conventions. Your product code lives in app/; reusable infrastructure lives in crates/.

If enabled, edit posts in app/content/blog/ and guides in app/content/docs/. Rebuild the app to publish Markdown changes. The docs that ship with your project are starter content for your own product.

The .shiprust.toml file records your project's generation details. Keep it with your codebase. Downloads use the template embedded in the running ShipRust site; repeat downloads preserve your saved options but are not archived copies of earlier ZIPs.

When you are ready to deploy, follow the CapRover guide or Docker hosting guide for your chosen setup.