Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jpgonzalezra/farcaster-frames-template
Template for jumpstarting production-ready Farcaster frames quickly. — no fuss, all fun!
https://github.com/jpgonzalezra/farcaster-frames-template
farcaster farcaster-frames rust
Last synced: 21 days ago
JSON representation
Template for jumpstarting production-ready Farcaster frames quickly. — no fuss, all fun!
- Host: GitHub
- URL: https://github.com/jpgonzalezra/farcaster-frames-template
- Owner: jpgonzalezra
- License: mit
- Created: 2024-02-04T00:56:12.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-02-07T01:50:38.000Z (9 months ago)
- Last Synced: 2024-08-03T18:10:38.281Z (3 months ago)
- Topics: farcaster, farcaster-frames, rust
- Language: Rust
- Homepage:
- Size: 15.6 KB
- Stars: 16
- Watchers: 2
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-frames - Rust Farcaster Frames Template
- awesome-farcaster-dev - `farcaster-frames-template` - ready Farcaster frames quickly. (Uncategorized / Uncategorized)
- awesome-farcaster-dev - `farcaster-frames-template` - ready Farcaster frames quickly. (Uncategorized / Uncategorized)
README
# Rust Farcaster Frames Template
Template for jumpstarting production-ready Farcaster frames quickly.
— no fuss, all fun!
## Features
- **Seamless Integration**: Easily create frames for Farcaster with Rust's performance.
- **Rapid Deployment**: Utilize Vercel for quick and effortless deployment of your frames.
- **Local Testing Support**: Includes setup for `localtunnel` to facilitate easy local testing and development.
## Prerequisites
Ensure you have the following installed to use this template effectively:
- Rust and Cargo
- Localtunnel
- Vercel CLI
## Getting Started
### Clone and Setup
1. Clone the repository to get started:
```bash
git clone https://github.com/jpgonzalezra/farcaster-frames-template.git
cd farcaster-frames-template
```
2. Install `vercel` globally:
```bash
npm install -g vercel
```
### Run Locally
Use the provided `Makefile` to streamline the local development process:
- when you run `make dev` if you do not have "localtunnel" installed it is installed
```bash
make dev
```
Each time you run `make dev`, a unique URL is generated, such as https://{something}.loca.lt. This URL can be directly copied and used to test your frame with the [Warpcast Embed Tools](https://warpcast.com/~/developers/frames), significantly streamlining the development and testing workflow.
### Deployment
Deploy your frame to Vercel with ease:
1. Log in to your Vercel account through the CLI:
```bash
vercel login
```
2. Deploy your project with Vercel:
```bash
vercel
```
Follow the prompts to link and deploy your project.
### Contributions
We welcome contributions to improve this template further. Please feel free to submit pull requests or open issues with your suggestions and feedback.