Browse the guides
Documentation
Guides to install Neatship, understand how each part works, build your product on it and ship it to production.
Get started
3 guides- Getting startedInstall Neatship, start the database, the API server, the web app and the background worker on your computer, and open the app as a sample user.
- Project structureWhere each part of Neatship lives, which rules the code follows, how files are named, and how lint, type checks and tests run.
- Working with AI assistantsBuild Neatship by describing features to Claude Code, Cursor or Codex: what the assistant checks and fixes on its own, the one command that says a change is done, example requests, and what to do when something fails.
Core features
2 guides- AuthenticationTurn on real sign-in with Clerk, protect sign-up against bots, understand how a request is authenticated from the browser to the database, and how workspaces, roles and permissions work.
- BillingTake test payments with a Stripe sandbox, change your plans and prices in code, understand how a payment becomes a plan, handle disputes, refunds and fraud warnings, and prepare Stripe for going live.
Build your product
4 guides- Add a featureA step-by-step walkthrough for adding a feature to Neatship by copying the Projects reference feature: database table, migration, service, API, web page, permissions, translations and tests.
- Background jobs and webhooksHow Neatship's background worker runs queued jobs and scheduled jobs (crons), how to add your own, and how Stripe and Clerk webhooks are received, stored, processed, recovered and cleaned up safely.
- Design and brandingUse Neatship's design system (tokens, components, icons, Storybook), light and dark themes, change the landing page's brand color and rename the product.
- TranslationsWrite translatable text with Lingui, extract and compile the catalogs of each package, translate server error messages, and add a new language to Neatship.
Ship
3 guides- TestingThe kinds of tests in Neatship, where they live, how to run all of them or a single file, how the API tests use their own database, and what CI checks on every pull request.
- SecurityWhat Neatship protects by default (guarded endpoints, workspace isolation, token and webhook checks, rate limits, GraphQL query limits, bot protection, encrypted secrets, alerts, logs, backups), what is not included, and the complete checklist before your first real customer.
- DeployPut Neatship in production on one server with Docker: choose the server, point three domains at it, fill in the production settings, deploy, update, keep nightly backups and copy them off the server, read the logs, turn on error alerts and roll back.