API Maker

The backend engine for the AI era

Chapters

What you will learn

  • A new project, and how API Maker should run: native or Full Docker
  • Why API Maker v4: one native program, downloaded and checked
  • Ports, resources, and the review before the start
  • The start, step by step, and the dashboard
  • Services, databases, the license and the logs
  • One folder for everything
  • Closing the app, and if the app is killed
In the docsRun on your computer
Transcript1332 words · click a time to play from there

Intro

API Maker Launchpad is a desktop app that runs API Maker on your computer. Pick a folder, and it installs API Maker version four, its MongoDB and Redis, and your databases. One click starts everything, and closing the app stops it.

A backend on a laptop, the usual way

A backend on a laptop usually takes a lot of setup. You set up a MongoDB replica set and Redis by hand. You install Node.js, and an npm install takes minutes. You write compose files, and ports clash between projects. And containers keep running after a crash. With Launchpad, one folder holds the whole project. API Maker v4 is one native program, downloaded and checked. Each project gets its own free ports.

And whatever the app started, it stops. In this video: the welcome screen, a new project, Native or Full Docker, the version, the start, step by step, the dashboard and the logs, one folder for everything, and closing safely.

The welcome screen

Here is the welcome screen. You can open a folder that already holds a project, or start a new one. On the right is the system check: Docker installed, Docker running, and Docker Compose. Below are the projects on this computer. The business APIs of Calm Home already run in the background. And at the top are Local and Cloud. Cloud mode installs API Maker on your own servers, in video fifty eight.

A new project

Nisha starts the API of the storefront. Click New project. Name the folder calm home API, in her folder of projects. Click Create. The folder is made, and its setup opens. There are four steps, and nothing runs before the last one.

Native or Full Docker

First: how should API Maker run? Both answers are drawn side by side. Full Docker runs everything in containers, with API Maker on the host network of Docker. Native runs API Maker as a program of this computer, and runs MongoDB, Redis, your databases, and the sandboxes of API Maker in Docker. In both, every file stays in the project folder. Native is the default. It is one native program, with the fastest start and the least memory, on any Docker.

Full Docker needs nothing on this computer but Docker. The Linux build of API Maker runs in a small Debian image, built on the first start. With both, MongoDB, Redis, your databases, and the sandboxes run in Docker. And the folder keeps every file. So you can switch later, and the data does not move.

The version

Next: which version of API Maker v4? The project name is Calm Home API. API Maker v4 is one native program, written in Rust. It is the only API Maker that Launchpad installs. The versions come live from npm, the latest first. It runs with its own MongoDB and Redis, and the recommended versions are picked for you. Why version four on your computer? There is no Node.js, and no npm install.

The build for this computer is downloaded, and runs as it comes. One port serves the APIs and the WebSockets. API Maker itself serves the admin panel. The code of your APIs still runs in eight languages, each in its own sandbox. And to switch to another version later, you make one choice in Project Settings, in video fifty seven.

Ports and resources

Next, ports and resources. Free ports were picked for you. With version four, one port serves the APIs and the WebSockets, and API Maker uses every core of this computer. If another program holds a port, it is flagged while you type, before anything starts. We go back to a free one. Now the review. It shows the project, Native, API Maker version four with its MongoDB and Redis, the license key for local runs, the ports, and the folder.

On a Mac, the first start downloads a few hundred megabytes. That is the build of API Maker, and the Linux agents of its sandboxes, then the images of MongoDB and Redis. Nothing is compiled.

The start, step by step

Click Install and start. The task shows every step. Steps that wait for nothing run at the same time. The Docker images download while API Maker downloads. The configuration is written. Then MongoDB and Redis start, and the replica set that API Maker needs is made for you. Seconds later, API Maker runs, and so does its admin panel. How is version four installed? On npm, API Maker v4 is a small main package that names one package for each platform.

Launchpad downloads only what this computer needs. On a Mac, that is its build, and the Linux build for the same processor, for the agents of the sandboxes. Each file is checked against the hash that npm publishes. It is unpacked under releases, in the folder of its version. Then the program is asked for its version before it is used. So a build that does not run here is refused before anything changes.

The last two releases are kept, so going back needs no download.

The dashboard and the logs

A few days later, here is the dashboard of Calm Home API. It is running, on version four, Native, as a native program. Here are the addresses: the admin panel, the API, and the WebSocket, on the port of the API. Here are the sign in details of the admin panel, the default users of a new installation. Change their passwords in the panel. Now the services. API Maker, with its APIs and WebSockets on one port, and its admin panel served by API Maker.

Then MongoDB and Redis, each with its uptime, processor, and memory. Below are the databases of the project: PostgreSQL, MongoDB, and SQL Server. Each one starts with the project, or when needed. Video fifty six adds them. A new project starts with the license key for local runs. Every feature works, and API Maker answers only this computer and private networks. To serve anyone else, set your own key in Project Settings.

Next to it is the activity of the project: created, installed, a database added, its instance created, and started. Logs shows every source in one place, live. API Maker says how it started: its databases, its admin panel, and its WebSockets on the port of its APIs. Launchpad says what it did, like the install of version four, package by package, and each container, here the MongoDB of API Maker.

One folder for everything

Everything lives in the folder you picked. The state of the project. API Maker, with its uploads, its license, and its releases. The configuration: the env file, the compose file, and the key of the replica set. The logs. And the data of every database. Docker only runs the containers. No data lives inside them, so deleting a container never deletes data.

The same project in Full Docker

Here is the same project in Full Docker. The dashboard says so, and API Maker runs as its Linux build. Its card says it runs in Docker, with its processor and memory, on a small Debian image without Node.js, built on this computer. To switch, change one setting in Project Settings, while the project is stopped.

Closing safely

Two projects are running. Closing the window stops every one of them at the same time: API Maker, its sandboxes, and every container of each folder. Then the app quits. And what if the app crashes, or is killed? Next to API Maker v4, the app starts its own small watchdog. Once the app is gone, the watchdog stops API Maker, removes its sandboxes, and stops the containers of the folder.

In Full Docker, the app writes a heartbeat every five seconds. After a minute without one, the API Maker container stops the project itself. And the next time you open the folder, anything left over is stopped.

Recap

To sum up. One folder holds a whole project. API Maker v4 is one native program, downloaded and checked, without Node.js. Native or Full Docker are both drawn before you choose. The start runs what it can at the same time. And nothing is left running when you close. Next: databases on your computer. API Maker. Build faster. Spend smarter. Deliver better.