The SumUp Developer Portal documents the integrations, SDKs, and public APIs that external developers use to build payment-acceptance solutions. The site is built with Astro and the Starlight documentation theme. Documentation pages are written in Markdown and MDX.
- Node.js 24.x, as specified in
.nvmrcandpackage.json - npm 11.x
Using a Node version manager such as nvm makes it easier to use the version required by the repository.
Clone the repository:
git clone git@github.com:sumup/sumup-developer.git
cd sumup-developerIf you use nvm, install and select the configured Node.js version:
nvm install
nvm useInstall the locked dependencies:
npm ciNo environment variables are required to install, build, or browse the documentation locally. Deployment-only integrations, including analytics and contact-form delivery, require secrets that are not stored in the repository.
npm run devOpen http://localhost:3000 in a browser. Most content and component changes appear without restarting the server.
Run the checks that match your change before opening a pull request:
| Command | Purpose |
|---|---|
npm run check |
Validate Astro, TypeScript, and content schemas |
npm run lint |
Lint source files and Markdown |
npm run test |
Run the Vitest test suite |
npm run build |
Create the production Cloudflare build |
npm run linkcheck |
Build the site and validate internal links |
The OpenAPI definition used by the API Reference is managed in another repository and synchronized into openapi.yaml. Do not edit this file directly. If you find a mistake or have an improvement to suggest, open an issue.