Getting Started

Get started with docs.page on your repository.

Getting started

Installation via Farmer (Recommended)

  1. Install Farmer

  2. Create a new project and add Aurora

farmer init aurora-example
cd aurora-example
farmer add aurora
  1. Add the example code to src/main.luau
local aurora = require("@aurora/")

-- GET request to /
aurora.get("/", function(req, res)
    res.send("Hello World")
end)

aurora.serve() -- runs the server on port 8080
  1. Run the server
lune run src/main.luau

Installation via Git

  1. Clone the Repository at the root of your project
git clone https://github.com/jonasarensmann/aurora.git
  1. Create main.luau in your project root and add the example code
local aurora = require("aurora/src")

aurora.get("/", function(req, res)
    res.send("Hello World")
end)

aurora.serve({
    port = 8080,
    debug = true,
})
  1. Run the server
lune run main.luau