EN Server Installation

Server installation: Windows, Linux and macOS

English · Türkçe · Languages / Diller

Scope: JSON API Forge 0.5.1 · Source review: 17 September 2026 · Language: English

Requirements and version selection

The main package is named json-api-forge and requires Python >=3.10. Official CI covers Python 3.10–3.14; the reviewed installation guide recommends 3.13 as its baseline. Package metadata and the tested version range are separate facts.

Install Git and a supported Python first. A source checkout and virtual environment provide a clear first setup. The v0.5.1 tag below belongs to the server branch; do not use it to obtain SDK or Editor source.

Windows PowerShell

git clone --branch v0.5.1 --single-branch https://github.com/YoungLionOrganization/JSON-API-Forge.git JSON-API-Forge-main
Set-Location JSON-API-Forge-main
py -3.13 -m venv .venv
.\.venv\Scripts\python.exe -m pip install -e .
.\.venv\Scripts\Activate.ps1
forge new MyService --slug my-service
forge init
forge validate
forge doctor
forge dev

If PowerShell blocks activation, call .\.venv\Scripts\forge.exe directly. Changing system-wide execution policy is unnecessary. If py -3.13 is unavailable, select your installed supported Python executable.

Linux and macOS

git clone --branch v0.5.1 --single-branch https://github.com/YoungLionOrganization/JSON-API-Forge.git JSON-API-Forge-main
cd JSON-API-Forge-main
python3 -m venv .venv
.venv/bin/python -m pip install -e .
source .venv/bin/activate
forge new MyService --slug my-service
forge init
forge validate
forge doctor
forge dev

The repository also provides scripts/install.sh and scripts/install.ps1. Install development/test dependencies with python -m pip install -e ".[dev]" when needed.

First startup

The default listener is 127.0.0.1:8000. Project documentation is available at http://127.0.0.1:8000/api/my-service/v1/_docs. The default minimal preset creates no resources. For CRUD, use the postgres-api preset in your first API. Despite its name, that preset starts with SQLite unless you supply a different database URL.

main does not include the example applications. Starting the runtime alone does not create a ready-made application. With no active applications, /health may succeed while /ready returns 503.

Install the package without a source checkout

python -m pip install "json-api-forge @ git+https://github.com/YoungLionOrganization/JSON-API-Forge.git@356106c6610ce817fb9dfb03e391c85dd1726b24"
mkdir my-deployment
cd my-deployment
forge new MyService --slug my-service
forge init
forge dev

This installs framework code into Python. The deployment directory owns app/, .env, databases and media. Installing a wheel or sdist does not migrate application data.

Compiled packages

Release assets include server packages for Linux glibc/musl x64/ARM64, macOS x64/ARM64 and Windows x64. The server installer selects x64 compatibility packages on Windows ARM64; the native ARM64 Editor is a separate product.

The --release installation path also downloads <asset>.sha256. Those sidecar files were not present in the v0.5.1 release asset list reviewed on 17 September 2026. This Wiki therefore uses source installation for the first run. Check that required checksum files exist before using the automatic release installer; do not bypass verification. See the complete asset list.

Sources and verification

This page describes the behavior at the pinned commits below. Recheck these contracts when upgrading.

• main/INSTALL.md
• main/pyproject.toml
• main/framework/cli.py
• main/scripts/install-release.sh
• main/docs/43-Platform-and-Hosting-Matrix.md

---

English home · All English pages · Version maintenance