Skip to content

Commit

Permalink
minimal README.me
Browse files Browse the repository at this point in the history
  • Loading branch information
mmatteo23 committed Nov 29, 2024
1 parent ac5a734 commit a93a143
Showing 1 changed file with 6 additions and 36 deletions.
42 changes: 6 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,10 @@
# Frames.js Starter Kit
# Brianker

This is a boilerplate repo to get started quickly with `frames.js`
This is the frontend repo for the Brianker project. It is a Next.js app that uses the [Frames.js](https://framesjs.org) library to create Farcaster frames and it also contains the dedicated web app.

## Quickstart

If running from the frames.js repository itself:

- Run `yarn` from the repository root
- Run `cd examples/framesjs-starter`

1. Install dependencies `yarn install`

2. Run the dev server `yarn dev`

3. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

4. Edit `app/page.tsx`

5. Visit [http://localhost:3000/debug](http://localhost:3000/debug) to debug your frame.

6. (Optional) To use a real signer (costs warps), copy `.env.sample` to `.env` and fill in the env variables following the comments provided

## Docs, Questions and Help

- [Frames.js Documentation](https://framesjs.org)
- [Awesome frames](https://github.com/davidfurlong/awesome-frames?tab=readme-ov-file)
- Join the [/frames-dev](https://warpcast.com/~/channel/frames-devs) channel on Farcaster to ask questions

## If you get stuck or have feedback, [Message @df please!](https://warpcast.com/df)

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!

## Deploy

```bash
vercel
```

more deployment links coming soon, PRs welcome!
1. Clone the repo
2. Run `bun install`
3. Run `bun dev`
4. Open [http://localhost:3000](http://localhost:3000) with your browser to see the web application.

0 comments on commit a93a143

Please sign in to comment.