Runa

A Go web framework for business applications.
Start with a lean micro-kernel and install capabilities on demand, from a single route to an enterprise full-stack application.

Docs · 中文文档 · Quick Start · Feedback

English | 简体中文

Why Runa

Status

Runa is a pre-1.0 public preview. The current public release target is v0.1.3, so APIs may still change before v1.0.

Runa currently targets Go 1.27rc1. Use a Go 1.27 release candidate toolchain until the stable Go 1.27 toolchain is available.

Install

Install only the modules you need:

go get github.com/duxweb/runa
go get github.com/duxweb/runa/route

Quick Start

package main

import (
    "context"

    "github.com/duxweb/runa"
    "github.com/duxweb/runa/route"
)

func main() {
    app := runa.New()
    app.Install(route.Provider(route.Addr(":8080")))

    route.Default().Get("/", func(ctx *route.Context) error {
        return ctx.JSON(runa.Map{"message": "Hello Runa"})
    })

    if err := app.Run(context.Background()); err != nil {
        panic(err)
    }
}

Run it:

go run .
curl http://localhost:8080/

Architecture

Runa is split into four layers:

Kernel        github.com/duxweb/runa
Transports    route / ws / jsonrpc / future grpc
Capabilities  cache / queue / database / storage / auth / session / view / lang ...
Drivers       redis / s3 / amqp / nats / oro ...

The root module provides application startup, dependency injection, config, commands, modules, lifecycle, hosts, errors, and application time. It does not bind HTTP, cache, database, or queue by default.

Capabilities

Driver modules keep heavier dependencies isolated, for example cache/redis, queue/redis, queue/amqp, storage/s3, message/nats, and observe/prometheus.

Beyond HTTP

Runa's kernel is transport-neutral. route is the HTTP transport, ws adds WebSocket support, jsonrpc adds JSON-RPC support, and gRPC is planned as a future transport.

Documentation

• English docs: https://duxweb.github.io/runa/
• Chinese docs: https://duxweb.github.io/runa/zh-cn/
• Naming conventions: docs/src/content/docs/contributing/naming.mdx
• Module boundaries: docs/src/content/docs/contributing/modules.mdx

Contributing

Read CONTRIBUTING.md before opening a pull request. Keep dependencies explicit, update tests for behavior changes, and update English and Chinese docs together for public-facing changes.

License

Runa is released under the MIT License. See LICENSE.