Docs

Installation

Step-by-step guide to install and configure the platform on your system or development environment.

Installation Process Start Installation

Step 0: Requirements

Operating System

macOS, Windows 10+, or Linux (Ubuntu 20.04+ recommended)

Runtime

Node.js version 16.0.0 or higher

Storage

Minimum 10GB disk space for the SDK

Installation Steps

Step 1: Install CLI

First install the command line interface tool globally.

npm install -g @myplatform/cli@latest

Step 2: Initialize Project

Create a new project directory and initialize it with the CLI.

Create directory
mkdir my-project
cd my-project
Initialize
myplatform init

Step 3: Install Dependencies

Run the CLI to install all required packages and dependencies.

myplatform install

Step 4: Start Server

Run the development server with default settings.

myplatform serve

Access at http://localhost:3000

Verify Installation

Check CLI Version

myplatform --version

Expected output: 1.2.3

Check Project Status

myplatform status

Should show "All systems operational"

Troubleshooting

Error: Command not found

Verify Node.js is installed and the CLI is globally available in your PATH.

which node
Expected output: /usr/bin/node

Permission Denied

Run the installation with elevated privileges.

sudo npm install -g @myplatform/cli@latest

Port Already in Use

Find and kill the process using the default development port.

lsof -i :3000
kill PID