Docs

Getting Started

Introduction

Welcome to the platform! This guide will walk you through the steps to get up and running quickly. We'll cover installation, basic configuration, and building your first project.

Installation

Install the CLI tool via npm:

npm install -g myplatform-cli

Or using yarn:

yarn global add myplatform-cli

Basic Setup

Initialize a new project:

myplatform init my-first-app

Navigate to the project folder and install dependencies:

cd my-first-app
npm install

Your First Project

Create a simple component:

// src/components/HelloWorld.jsx
export default function HelloWorld() {
  return <h1>Hello, World!</h1>;
}

Run the development server:

npm run dev

Open http://localhost:3000 in your browser to see the result.

Troubleshooting

  • Command not found: Ensure npm global bin is in your PATH.
  • Port already in use: Change the dev server port in .env or kill the conflicting process.
  • Build failures: Verify Node.js version matches the project requirements.