https://github.com/nekofar/farcaster-frames-template
This is a user-friendly template that is suitable for both novice and experienced developers.
https://github.com/nekofar/farcaster-frames-template
farcaster farcaster-frame farcaster-protocol fracaster-frames frames hono localtunnel template typescript
Last synced: 5 months ago
JSON representation
This is a user-friendly template that is suitable for both novice and experienced developers.
- Host: GitHub
- URL: https://github.com/nekofar/farcaster-frames-template
- Owner: nekofar
- License: apache-2.0
- Created: 2024-01-31T06:47:54.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-29T09:37:56.000Z (7 months ago)
- Last Synced: 2024-10-29T11:42:17.721Z (7 months ago)
- Topics: farcaster, farcaster-frame, farcaster-protocol, fracaster-frames, frames, hono, localtunnel, template, typescript
- Language: TypeScript
- Homepage:
- Size: 580 KB
- Stars: 35
- Watchers: 2
- Forks: 13
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-frames - Node JS
- awesome-farcaster-dev - `farcaster-frames-template` - friendly template that is suitable for both novice and experienced developers.  (Uncategorized / Uncategorized)
- awesome-farcaster-dev - `farcaster-frames-template` - friendly template that is suitable for both novice and experienced developers. (Uncategorized / Uncategorized)
README
# Farcaster Frames Template
[](https://github.com/nekofar/farcaster-frames-template/releases)
[](https://github.com/nekofar/farcaster-frames-template/blob/master/LICENSE)
[](https://x.com/nekofar)
[](https://warpcast.com/nekofar)
[](https://ud.me/nekofar.crypto)
Farcaster Frames Template is an easy-to-use template designed for beginners and experienced developers alike. It
provides a robust starting point for building Farcaster Frames, streamlining the development process. This template is
ideal for those looking to create custom frames quickly and efficiently.
## Getting Started
### Prerequisites
- Node.js (Version 18 or later)
- A text editor like VSCode
- Basic understanding of TypeScript and Node.js
### Use Template
You can use this repository as a template to create a new GitHub repository with the same directory structure and files.
Here's how:
1. On the [repository page](https://github.com/nekofar/farcaster-frames-template), click the **Use this template**
button.
2. Choose the owner of the new repository and enter a repository name.
3. Optionally, add a description for your repository.
4. Choose the repository visibility (Public or Private).
5. Click **Create repository** to create your new repository from template.
After creating your repository from this template, clone it and install the dependencies.
### Installation
1. Clone the repository:
```bash
git clone https://github.com/yourname/farcaster-frames-template.git
```
2. Navigate to the project directory:
```bash
cd farcaster-frames-template
```
3. Install the dependencies:
```bash
pnpm install
```
4. Start the development server:
```bash
pnpm run dev
```
### Usage Guide
The template uses [Localtunnel](https://github.com/localtunnel/localtunnel) which allows you to easily test your frames
without the need to deploy them. Everytime running your project, you will receive a random URL, for
example `https://thirty-glasses-tell.loca.lt`. You can directly copy this URL and test your frame using
the [Warpcast Embed Tools](https://warpcast.com/~/developers/embeds). This makes the
development and testing process much more efficient and straightforward.
For detailed information on working with Farcaster Frames, refer to
the [Farcaster Frames documentation](https://docs.farcaster.xyz/learn/what-is-farcaster/frames).
Additionally, to learn more about Hono, visit the [Hono documentation](https://hono.dev/top).
## Contributing
Contributions are what make the open source community such a fantastic place to learn, inspire, and create. Any
contributions you make are **greatly appreciated**