Name		Name	Last commit message	Last commit date
.github		.github
public		public
scripts		scripts
src		src
.gitattributes		.gitattributes
.gitignore		.gitignore
.harper-dictionary.txt		.harper-dictionary.txt
.node-version		.node-version
.npmrc		.npmrc
.nvmrc		.nvmrc
.prettierignore		.prettierignore
.prettierrc.mjs		.prettierrc.mjs
.rumdl.toml		.rumdl.toml
AGENTS.md		AGENTS.md
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
SECURITY.md		SECURITY.md
astro.config.ts		astro.config.ts
biome.json		biome.json
ec.config.mjs		ec.config.mjs
eslint.config.js		eslint.config.js
openapi.json		openapi.json
openapi.yaml		openapi.yaml
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json
vitest.config.ts		vitest.config.ts
wrangler.jsonc		wrangler.jsonc

Repository files navigation

SumUp Developer Portal 👩‍💻

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.

Local Development

Prerequisites

Node.js 24.x, as specified in .nvmrc and package.json
npm 11.x

Using a Node version manager such as nvm makes it easier to use the version required by the repository.

Set up the Project

Clone the repository:

git clone git@github.com:sumup/sumup-developer.git
cd sumup-developer

If you use nvm, install and select the configured Node.js version:

nvm install
nvm use

Install the locked dependencies:

npm ci

No 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.

Start the Development Server

npm run dev

Open http://localhost:3000 in a browser. Most content and component changes appear without restarting the server.

Validate Changes

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

API Specs

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.