https://github.com/ncitron/oframl

A framework for building Farcaster Frames in OCaml
https://github.com/ncitron/oframl

Last synced: about 1 month ago
JSON representation

A framework for building Farcaster Frames in OCaml

• Host: GitHub
• URL: https://github.com/ncitron/oframl
• Owner: ncitron
• License: mit
• Created: 2024-02-02T03:53:31.000Z (5 months ago)
• Default Branch: master
• Last Pushed: 2024-02-04T02:36:50.000Z (5 months ago)
• Last Synced: 2024-02-12T02:29:29.758Z (5 months ago)
• Language: OCaml
• Size: 15.6 KB
• Stars: 8
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Lists

• awesome-farcaster - ncitron.eth's oframl
• awesome-frames - Oframl framework for building frames in OCaml

README

        
## Oframl

Oframl is a simple framework for building Farcaster Frames in OCaml.

## Usage

```OCaml

open Oframl

let image_handler (data : string) =

  let str = if String.equal data "initial" then

    "Click to fetch FID"

  else

    [%string "FID: %{data}"]

  in

  [%string

    {|

        

        

          %{str}

        

      |}]

;;

let frame_handler (): frame = 

  { title = "FID Check"

  ; image_extra_data = "initial"

  ; post_extra_data = ""

  ; buttons = [ { content = "Check FID" } ]

  }

;;

let post_handler (act : action) (_data : string) : frame =

  { title = "FID Check"

  ; image_extra_data = string_of_int act.fid

  ; post_extra_data = ""

  ; buttons = []

  }

;;

let base_url = "https://df78-72-69-118-50.ngrok-free.app" in

let start = Server.start base_url frame_handler post_handler image_handler in

Lwt_main.run start

```

## Examples

To view more examples see [examples](./examples)