Skip to content
MiniGateway

Getting Started

import { Card, CardGrid, Steps } from ‘@astrojs/starlight/components’;

This guide will help you set up MiniGateway in your project.

Prerequisites

Section titled “Prerequisites”
  • Node.js 24.x or later
  • pnpm 10.x or later (recommended)

Installation

Section titled “Installation”

Clone the repository

Section titled “Clone the repository”
Terminal window
git clone https://github.com/luozhouyang/minigateway.git
cd minigateway

Install dependencies

Section titled “Install dependencies”
Terminal window
vp install

Start the development server

Section titled “Start the development server”
Terminal window
vp run web#dev

The web application will be available at http://localhost:3000.

Explore the API

Section titled “Explore the API”

Open your browser and navigate to the API documentation to see available endpoints.

Project Structure

Section titled “Project Structure”
minigateway/
├── apps/
│   ├── web/          # Web dashboard application
│   ├── docs/         # Documentation site
│   └── website/      # Landing page
├── packages/
│   ├── core/         # Core gateway engine
│   └── cli/          # CLI tools
└── tools/            # Development tools

Next Steps

Section titled “Next Steps”
Learn the fundamental concepts behind MiniGateway's architecture. Configure your gateway routes, plugins, and more. Explore the complete API documentation.