#moonway

· · English | 简体中文

#Why moonway?

#Features

• HTTP routing — expressive routes with path parameters and a composable middleware pipeline.
• Database layer — a typed data abstraction with migrations and a fluent query API. SQLite works out of the box.
• Caching — Redis-backed response caching with a configurable TTL (app.cache(...)); requests are served untouched when Redis is unavailable.
• WebSocket — first-class support for realtime features like chat and live updates.
• Admin dashboard — a CRUD admin UI generated from your models. Zero frontend work required.
• REPL console — an interactive console to query data and poke at your running app.
• Code generator — scaffolding for models, handlers, and more, so boilerplate never slows you down.
• Frontend included — an integrated Preact workflow for the client side of your app.

#Quick start

moon new hello-moonway
cd hello-moonway
# moonway is a server-side framework: switch the project to the native backend
awk '{sub(/preferred_target = "wasm"/, "preferred_target = \"native\"")} 1' moon.mod > moon.mod.tmp && mv moon.mod.tmp moon.mod
moon add daqing/moonway
# register the dependency in the main package too
printf 'import {\n  "daqing/moonway",\n}\n' >> cmd/main/moon.pkg

///|
fn main {
  let app = @moonway.new()
  app.get("/", ctx => ctx.text("Hello, moonway!"))
  app.listen(3000)
}

moon run cmd/main

#The full stack, in one file

import {
  "daqing/moonway",
  "daqing/moonway/db",
  "moonbitlang/core/json",
}

supported_targets = "native"

pkgtype(kind: "executable")

options(
  link: { "native": { "cc-link-flags": "-lsqlite3" } },
)

///|
struct Post {
  id : Int32
  title : String
  body : String
} derive(ToJson, FromJson)

///|
let posts : @db.Table = @db.table("posts", [
  @db.column("id", @db.IntT, primary=true),
  @db.column("title", @db.TextT),
  @db.column("body", @db.TextT),
])

///|
fn main {
  let app = @moonway.new()
  let db = @moonway.sqlite("app.db")
  if !db.migrate([@db.migration(1, "create posts", [posts.create_sql()])]) {
    abort("migrations failed")
  }
  app.get("/posts", ctx => {
    let items : Array[Json] = db.select_raw(posts, "1=1", [], limit=100)
    ctx.json(Json::array(items))
  })
  app.post("/posts", ctx => {
    let row : Json? = Some(@json.parse(ctx.body())) catch { _err => None }
    match row {
      Some(Object(fields)) =>
        if db.insert_raw(posts, fields) {
          ctx.status(201).json(Json::object(fields))
        } else {
          ctx.status(500).text("insert failed")
        }
      _ => ctx.status(400).text("invalid JSON body")
    }
  })
  // A ready-to-use admin UI for your data, served at /admin
  app.admin(db, [posts])
  app.listen(3000)
}

#The toolkit

#Generator

moonway generate scaffold Post title:string body:string

created  models/post.mbt
created  handlers/posts.mbt
created  migrations/001_create_posts.mbt
updated  admin registry

The moonway CLI ships with the framework — install it with moon install daqing/moonway.

#Admin dashboard

#REPL console

$ moonway console
moonway 0.1.0 · connected to sqlite://app.db
moonway> Post.count()
42

#Roadmap

• Project setup — repository, toolchain, CI
• HTTP router & middleware pipeline
• SQLite database layer & migrations
• Code generator (moonway new, moonway generate)
• Redis cache middleware
• WebSocket support
• Auto-generated admin dashboard
• REPL console
• Preact frontend integration
• Guides, examples & documentation

#Contributing

git config core.hooksPath .githooks

#License