Quickstart

Welcome to the Niksphere Quickstart hub! Choose your role below to find the relevant quickstarts, setup guides, and tutorials.

System Administrators & DevOps

For IT administrators, infrastructure engineers, and DevOps specialists responsible for deploying and operating the Niksphere Engine and platform services:

• Engine Installation, Setup & Run
  Install, configure environment variables (NIKSPHERE_ENGINE_*), and run the Engine with PostgreSQL or embedded SQLite.
• Engine Service Management Guide
  Run the Engine as a native background system service (Windows Service / systemd).
• Engine Deployment Architecture
  Compare Self-Hosted (Docker Container / Standalone Binary) and Cloud (Fully Managed) deployment models.

Application Developers & API Consumers

For software developers, API consumers, and key users building applications or integrating external systems:

• Consuming the Engine API with Postman
  Authenticate via OIDC using Postman's native OAuth 2.0 integration and consume the Admin API, Runtime Entity CRUD, and RPC Symbol Execution.
• CLI Installation & Setup
  Install the Niksphere CLI (nik), authenticate with Niksphere Cloud, and connect to Engine environments.
• Developing & Publishing Apps in VS Code
  Step-by-step walkthrough of building, compiling (Ctrl+Shift+B), and publishing (Ctrl+F5) apps.
• Managing Environments & Apps in VS Code
  Manage Niksphere Cloud (Fully Managed) and Self-Hosted environments, live log streaming, and app lifecycles.

Enterprise Managers & Key Users

For business analysts and department leads customizing UI layouts and understanding platform capabilities:

• Product Overview & Vision
  Product capabilities for enterprises, end-users, and developers.
• Layer System ("Everything is an App")
  Understanding the 4 customization layers (No-Code, Low-Code, Pro-Code).