Skip to content

Commit

Permalink
initial frames (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
Tarun-k-Gupta authored Jun 11, 2024
1 parent ff27ffd commit 6d1519d
Show file tree
Hide file tree
Showing 16 changed files with 3,625 additions and 448 deletions.
7 changes: 2 additions & 5 deletions frame/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,11 @@
.pnp.js
.yarn/install-state.gz

.env
# testing
/coverage

# next.js
/.next/
.next
/out/

# production
Expand All @@ -34,6 +33,4 @@ yarn-error.log*

# typescript
*.tsbuildinfo
next-env.d.ts

mocks.json
next-env.d.ts
175 changes: 23 additions & 152 deletions frame/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,172 +1,43 @@
# framesjs-starter
# template-next

## 0.2.4
## 0.0.5

### Patch Changes

- 0faa11e: fix: only use mock hub url in development
- Updated dependencies [4fc8fef]
- Updated dependencies [6c9b09d]
- Updated dependencies [faa44a5]
- Updated dependencies [5a609e3]
- [email protected]
- Updated dependencies [651e6b1]
- Updated dependencies [fe92ca0]
- [email protected]

## 0.2.3
## 0.0.4

### Patch Changes

- 2b57a1c: feat: only followers can mint example
- Updated dependencies [40e99b3]
- [email protected]
- fix: bump frames.js version

## 0.2.2
## 0.0.3

### Patch Changes

- 72e6617: feat: tx support
- Updated dependencies [72e6617]
- Updated dependencies [7ccc562]
- [email protected]
- Updated dependencies [0d373a9]
- Updated dependencies [0d373a9]
- Updated dependencies [0d373a9]
- Updated dependencies [0d373a9]
- Updated dependencies [0d373a9]
- [email protected]

## 0.2.1
## 0.0.2

### Patch Changes

- Updated dependencies [01fc5fe]
- Updated dependencies [60c6e56]
- Updated dependencies [e335829]
- Updated dependencies [eee74a9]
- [email protected]
- b9bed81: chore: bump frames.js dependency to v0.12.1

## 0.2.0

### Minor Changes

- 845b30c: refactor: make frame validation errors arbitraty, remove unnecessary validateFrame function

### Patch Changes

- Updated dependencies [845b30c]
- Updated dependencies [ce1cec6]
- Updated dependencies [845b30c]
- [email protected]

## 0.1.12

### Patch Changes

- 99b998f: fix: debugger build
- 108280c: feat: add mock hub state to debugger
- 1707ea4: feat: `DEBUG_HUB_HTTP_URL` env var
- Updated dependencies [18c887d]
- Updated dependencies [0ba4b88]
- Updated dependencies [f9d4356]
- [email protected]

## 0.1.11

### Patch Changes

- 157ec44: chore: update fallback neynar hub api url
- 548a9c3: feat: multi-page example
- 426d5eb: feat: validate frame image data uri length in debugger
- 8317894: fix: reset input state on submit, waiting state buttons styling
- Updated dependencies [157ec44]
- Updated dependencies [426d5eb]
- Updated dependencies [70a0ff6]
- Updated dependencies [d1596ac]
- Updated dependencies [62be50d]
- [email protected]

## 0.1.10

### Patch Changes

- Updated dependencies [40d2662]
- [email protected]

## 0.1.9

### Patch Changes

- d861fb9: fix: url validation and smoother navigation
- Updated dependencies [e54b9ad]
- Updated dependencies [a09c555]
- [email protected]

## 0.1.8

### Patch Changes

- 2150e11: chore(debugger): remove mint spec warning
- Updated dependencies [ccb8317]
- [email protected]

## 0.1.7

### Patch Changes

- 8112f6f: fix: use neynar hubs as fallback
- Updated dependencies [800d887]
- Updated dependencies [8112f6f]
- Updated dependencies [fd70614]
- Updated dependencies [b71f05b]
- Updated dependencies [8112f6f]
- [email protected]

## 0.1.6

### Patch Changes

- ccd3302: feat: JSX-based frame image rendering
- Updated dependencies [ccd3302]
- [email protected]

## 0.1.5

### Patch Changes

- 03d041e: feat: mint action
- Updated dependencies [03d041e]
- [email protected]

## 0.1.4

### Patch Changes

- 3ed2cef: fix: generate correct image data in `generateImage` example
- Updated dependencies [0d9cfaf]
- [email protected]

## 0.1.3

### Patch Changes

- Updated dependencies [608bac9]
- [email protected]

## 0.1.2

### Patch Changes

- 40d0ad7: feat: Add `getFrameMessage`, which parse frame action payloads and optionally fetches additional context from hubs.

feat(debugger): Forward unmocked hub requests to an actual hub.

- Updated dependencies [40d0ad7]
- Updated dependencies [57649be]
- Updated dependencies [518ada3]
- [email protected]

## 0.1.1
## 0.0.1

### Patch Changes

- 05af691: feat: adds an option to impersonate an FID as an alternative to creating a new onchain signer
- fb3cfaa: fix(debug): untrusted data url now uses original frame url
- 99536fb: fix: frame action message creation to not include inputText if inputText was not requested by the frame
- Updated dependencies [1a73918]
- Updated dependencies [99536fb]
- Updated dependencies [501861d]
- Updated dependencies [1598cb6]
- [email protected]
- Updated dependencies [424b0ea]
- Updated dependencies [e681ce9]
- Updated dependencies [40934fb]
- Updated dependencies [2290278]
- Updated dependencies [e681ce9]
- [email protected]
43 changes: 10 additions & 33 deletions frame/README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,17 @@
# Frames.js Starter Kit
# Frames.js Next example

This is a boilerplate repo to get started quickly with `frames.js`
Simple Frames.js app using Next.js.

## Quickstart
### Installation

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)
```sh
npm install
```

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

## Deploy
Following command will open frames debugger and also run the app in development mode.

```bash
vercel
```sh
npm run dev
```

more deployment links coming soon, PRs welcome!
5 changes: 5 additions & 0 deletions frame/app/frames/frames.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import { createFrames } from "frames.js/next";

export const frames = createFrames({
basePath: "/frames",
});
Loading

0 comments on commit 6d1519d

Please sign in to comment.