Skip to content
This page View Markdown Open in ChatGPT Open in Claude

Local setup

A local API Maker is the place to build and test APIs before they reach a server : your own admin panel, your own databases, and your code in your editor. API Maker Local Run sets it up for you : a desktop app for macOS, Windows and Linux which needs Docker on your computer, and the same app later deploys to your servers.

API Maker Local Run

The desktop app installs API Maker from npm on a Node.js runtime it downloads and verifies, starts MongoDB and Redis in Docker, runs the admin panel and shows you the URLs and the sign-in details. Pick a folder, press Start, and your API Maker is running.

⌘macOS 13 Ventura or later · Apple silicon and Intel UniversalDisk image .dmgZip .zip Open the .dmg and drag the app to Applications.
⊞Windows Windows 10 and 11 x64Installer .exePortable .zip ARM64Installer .exePortable .zip Installs for your user, no administrator rights needed.
>_Linux Ubuntu 22.04+, Debian 12+, Fedora 39+ x64Debian, Ubuntu .debAny distro .tar.gz ARM64Debian, Ubuntu .debAny distro .tar.gz Needs GTK 3 and WebKitGTK 4.1 ; the .deb installs them.
Version 1.0.0 · the SHA-256 checksum of every file and the install steps are on apimaker.dev/download
  • Databases in a few clicks : MongoDB, PostgreSQL, MySQL, MariaDB, SQL Server, Oracle, TiDB and Percona Server, several of each, with the API Maker instance created in one click.
  • Your code in your editor : the Local Client page keeps a folder in sync with API Maker both ways, for VS Code, WebStorm, Zed or any editor.
  • Projects side by side : every project runs on its own ports, in its own folder.
  • Ready for production : the Cloud tab of the same app deploys API Maker to your servers. See Install on a server.

Run on your computer describes the app in detail : the first run, the ports, the folder, the license key and the Local Client.