Skip to content

Latest commit

 

History

History
75 lines (56 loc) · 2.27 KB

README.md

File metadata and controls

75 lines (56 loc) · 2.27 KB

Banner

Release Static Badge Static Badge

Web server runtime for Lua and LuaJIT written in Rust and running on Axum. The goal is to get as much performance as possible while writing the web server logic in lua instead for faster iteration, fault-tolerance and no-build requirements. This project is internally used here at ArkForge and many others.

Example

Typically in lua you can register routes like below, binded to a method

Astra.get("/", function()
    return "hello from default Astra instance!"
end)

and starting the server with

Astra.run()

You can also use the local variables within routes

local counter = 0
Astra.get("/count", function()
    counter = counter + 1
    -- and also can return JSON
    return { counter }
end)

Requests and Responses and their configuration are provided when needed

Astra.get("/", function(req, res)
    -- set header code
    res:set_status_code(300)
    -- set headers
    res:set_header("header-key", "header-value")

    -- consume the request body
    print(req:body():text())

    return "Responding with Code 300 cuz why not"
end)

There are also utilities provided such as a PostgreSQL, http client requests, lua extra utils, and async tasks.

-- spawn an async task that does not block the running thread
spawn_task(function ()
    -- HTTP Request to check your IP address
    local response = http_request("https://myip.wtf/json"):execute()
    pretty_print(response:status_code())
    pretty_print(response:remote_address())
    pretty_print(response:body():json())
end)

Note

This project is very young and not recommended for production at scale. Contributions, however, are welcome.

Some features that are missing but are planned:

  • Websockets
  • TLS/SSL support
  • Middleware
  • SQLite support
  • Templating