ZuploZuplo
LoginSign Up
  • Documentation
  • API Reference
Introduction
Getting Started
    Develop using the Portal
      1 - Setup Your Gateway2 - Rate Limiting3 - API Key Auth4 - Deploy5 - Dynamic Rate LimitingMCP - Quick start
    Develop Locally
      1 - Setup Your Gateway2 - Rate Limiting3 - API Key Auth
Concepts
Development
Policies
Handlers
API Keys
MCP Server
MCP Gateway
AI Gateway
Developer Portal
    IntroductionLocal DevelopmentUpdating VersionsNode Modules & Customization
    Configuration
    Writing
    OpenAPI
    Authentication
    Integrations
    Guides
    Extending
    Components
Monetization
Deploying & Source Control
Observability
Networking & Infrastructure
Account Management
Programming API
Build with AI
Zuplo CLI
Migration Guides
Platform LimitsSecuritySupportTrust & ComplianceChangelog
powered by Zudoku
Developer Portal

Local Development

Developing the Dev Portal locally is straightforward and provides a great developer experience with live updates and hot reloading. Follow these steps to get started.

Prerequisites

  • Node.js >=v22.7.0 (or >=20.19 will work as well)
  • Git

Getting Started

  1. Clone the Zuplo repository

    TerminalCode
    git clone <repository-url>
  2. Install dependencies

    TerminalCode
    npm install
  3. Navigate to the docs directory

    TerminalCode
    cd docs
  4. Start the development server

    TerminalCode
    npm run dev
  5. Open your browser

    Navigate to http://localhost:3000 to see your Dev Portal.

Development Workflow

Once the development server is running, you can:

  • Edit content: Make changes to any Markdown, MDX, or configuration files
  • Live updates: Your browser will automatically refresh when you save changes
  • Hot reloading: Most changes will be reflected instantly without a full page reload
  • Real-time feedback: See your changes immediately as you develop

The development server watches for file changes and automatically rebuilds the site, providing an excellent developer experience for creating and maintaining your documentation.

What's Next?

  • Learn about writing content
  • Check out the configuration file
  • See how you can customize the Dev Portal
Edit this page
Last modified on August 8, 2025
IntroductionUpdating Versions
On this page
  • Prerequisites
  • Getting Started
  • Development Workflow
  • What's Next?