Skip to content

LegoCitySmart City Builder

A reusable platform for modern, map-based urban dashboards

LegoCity Documentation

Welcome to LegoCity — a Smart City Builder platform for modern, map-based urban dashboards.

Quick navigation

🚀 New to LegoCity?

Start here if you are seeing LegoCity for the first time.

SectionDescription
🚀 Getting startedUnderstand the core concepts and run LegoCity for the first time
⬇️ InstallationChoose an installation method: local, Docker, or development environment
🎓 User guideLearn how to use maps, layers, dashboards, and entities
⚙️ ConfigurationConfigure data sources, Mapbox, brokers, APIs, and AI integration

🛠️ For developers

Use these sections if you want to extend or contribute to LegoCity.

SectionDescription
💻 Development guideSet up a dev environment, create blocks, and extend the platform
🤖 AI integrationConfigure the Payload AI plugin and OpenRouter-based models
☁️ DeploymentDeploy LegoCity using Docker, AWS, VMs, Cloudflare, or Coolify
📚 ReferenceTroubleshooting, API details, and technical reference material

Quick start

bash
# Clone repository
git clone https://github.com/CTU-SematX/LegoCity.git
cd LegoCity/dashboard

# Install dependencies
pnpm install

# Configure environment
cp .env.example .env
# Edit .env with your settings

# Start development server
pnpm dev

Access at: http://localhost:3000

👉 See the Quick Start Guide for detailed instructions.

Architecture Overview

LegoCity uses a three-layer architecture:

  1. Context & Data Layer - FIWARE/NGSI-LD brokers with standardized city data
  2. Content & UI Layer - PayloadCMS + Next.js for configurable dashboards
  3. Integration Layer - API proxies, AI helpers, external services

👉 See the Architecture Guide for detailed diagrams and explanations.

Community & Support

Getting Help

Contributing

We welcome contributions! See:

Resources

What's Next?

I'm New

Start Here:

  1. Read Getting Started
  2. Follow Quick Start
  3. Explore User Guide

I Want to Deploy

Deploy to Production:

  1. Deployment Overview
  2. Choose deployment method
  3. Operations Guide

Ready to begin? Head to the Getting Started Guide

Released under the CC-BY-4.0 License.