https://github.com/vrypan/farma
Farcaster Relationships Management
https://github.com/vrypan/farma
farcaster farcaster-frames
Last synced: about 1 month ago
JSON representation
Farcaster Relationships Management
- Host: GitHub
- URL: https://github.com/vrypan/farma
- Owner: vrypan
- License: mit
- Created: 2025-02-09T19:22:08.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-05T11:41:56.000Z (about 1 year ago)
- Last Synced: 2025-04-05T12:27:49.888Z (about 1 year ago)
- Topics: farcaster, farcaster-frames
- Language: Go
- Homepage: https://farma.vrypan.net
- Size: 1.55 MB
- Stars: 12
- Watchers: 1
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [Add this frame](https://warpcast.com/~/frames/launch?domain=farma.vrypan.net) to receive notifications about farma updates and versions.
# farma
**farma** (**FA**rcaster **R**elationships **MA**nagement) is built to make Farcaster Frames v2
notifications easy, and help you get insights on how users interact with your
frames notifications.
- When did a user first add your frame?
- How many notifications have you sent them since?
- When did they enable/disable notifications
- Which Farcaster clients are they using to interact with your frame?
# Features
- Small footprint, fast, no external dependencies (but you will need access to a read hub).
- Supports multiple frames.
- Supports multiple Farcaster apps.
- Keeps track of subscription activity per user (frame added/removed, notifications enabled/disabled, notifications sent).
- Updates user subscription status based on notification replies from the app (success, rate limited, invalid tokens).
- Allows batch sending notifications to all users subscribed to a frame.
# Quick Start
(This will improve a lot, but in case someone wants to give it an early try.)
## 1. Download binary
Download the binary corresponding to your system from `https://github.com/vrypan/farma/releases`.
If you're using macOS, use `brew install vrypan/farma/farma`
## 2. Setup
Run `farma setup`.
Make sure you save the private key. The key is used to sign API requests,
and you will need it even if you are using the CLI commands (they actually use the API
under the hood)
## 3. Start the server
Start the farma server: `farma server`
## 4. Configure a frame
Assuming you already have your frame, you need to configure it in farma.
You will need a short name for your frame, and the frame domain.
If you want to call your frame `myframe`, and its domain is `farma.vrypan.net`, you have to run:
`farma frame-add myframe farma.vrypan.net`
## 5. Update .well-knowν/farcaster.json
The previous command returned a relative endpoint, something like `/f/a2b01541-778d-4a2b-9375-8232c70a6ddf`.
Hint: You can use `farma frames-list` to get all frames and endpoints configured:
Add the endpoint (including your server name) in the frame's `.well-known/farcaster.json` callbackUrl.
For example,
```
"webhookUrl": "https://my-frame-notifications.com/f/a2b01541-778d-4a2b-9375-8232c70a6ddf"
```
**Make sure you re-validate the frame in Warpcast dev tools.**
## 6. Send notifications!
You can send a notification to all users subscribed to a frame:
```
farma notification-send "myframe" "Hello" "Hello, there!" ""
```
# Run as a service
If you want to configure farma as a systemd service, see [Documentation/systemd.md](Documentation/systemd.md).
# API
farma provides a REST API to let you use it from your own applications.
See: [Documentation/API.md](Documentation/API.md)