⚡ 3-Minute Bootstrap: Hello World¶

Get up and running with Neuroglia in under 3 minutes! This quick-start guide gets you from zero to a working API in the fastest way possible.

For a fully-featured application template with authentication, frontend, and all common concerns pre-configured, check out the Starter App Repository. This guide shows the minimal hello-world approach.

A minimal "Hello Pizzeria" API with one endpoint that demonstrates the basic framework setup.## 🚀 Quick Setup

Prerequisites¶

• Python 3.8+ installed
• pip package manager

Installation¶

# Create new directory
mkdir hello-pizzeria && cd hello-pizzeria

# Install Neuroglia
pip install neuroglia-python[web]

📝 Create Your First API¶

Create main.py:

from neuroglia.hosting.web import WebApplicationBuilder
from neuroglia.mvc import ControllerBase
from classy_fastapi.decorators import get

class HelloController(ControllerBase):
    """Simple hello world controller"""

    @get("/hello")
    async def hello_world(self) -> dict:
        """Say hello to Mario's Pizzeria!"""
        return {
            "message": "Welcome to Mario's Pizzeria! 🍕",
            "status": "We're open for business!",
            "framework": "Neuroglia Python"
        }

def create_app():
    """Create the web application"""
    builder = WebApplicationBuilder()

    # Add SubApp with controllers
    builder.add_sub_app(
        SubAppConfig(
            path="/api",
            name="api",
            controllers=[HelloController]
        )
    )

    # Build app
    app = builder.build()

    return app

if __name__ == "__main__":
    import uvicorn
    app = create_app()
    uvicorn.run(app, host="0.0.0.0", port=8000)

🏃‍♂️ Run Your API¶

python main.py

🎉 Test Your API¶

Open your browser and visit:

• API Endpoint: http://localhost:8000/hello
• API Documentation: http://localhost:8000/docs

You should see:

{
  "message": "Welcome to Mario's Pizzeria! 🍕",
  "status": "We're open for business!",
  "framework": "Neuroglia Python"
}

✅ What You've Accomplished¶

In just 3 minutes, you've created:

• ✅ A working FastAPI application with Neuroglia
• ✅ Automatic API documentation (Swagger UI)
• ✅ Controller-based routing with clean architecture
• ✅ Automatic module discovery
• ✅ Dependency injection container setup

🔄 Next Steps¶

Now that you have the basics working:

1. 🛠️ Local Development Setup - Set up a proper development environment
2. 🍕 Mario's Pizzeria Tutorial - Build a complete application (1 hour)
3. 🎯 Architecture Patterns - Learn the design principles
4. 🚀 Framework Features - Explore advanced capabilities

🔗 Key Concepts Introduced¶

This hello world example demonstrates:

• Controller Pattern - Web request handling
• Dependency Injection - Service container setup
• WebApplicationBuilder - Application bootstrapping

This is just the beginning! The framework includes powerful features like CQRS, event sourcing, and advanced data access patterns. Continue with the Local Development Setup to explore more.