https://github.com/mod-protocol/frames-fun-extension
Frames.fun browser extension that implements open frames
https://github.com/mod-protocol/frames-fun-extension
openframes
Last synced: about 1 year ago
JSON representation
Frames.fun browser extension that implements open frames
- Host: GitHub
- URL: https://github.com/mod-protocol/frames-fun-extension
- Owner: mod-protocol
- Created: 2024-03-26T08:39:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-21T12:31:44.000Z (over 1 year ago)
- Last Synced: 2025-04-26T06:42:28.663Z (about 1 year ago)
- Topics: openframes
- Language: TypeScript
- Homepage: https://xframes.vercel.app
- Size: 714 KB
- Stars: 20
- Watchers: 7
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Frames.fun
Frames.fun is a browser extension for Google Chrome which allows you to interact with [frames](https://docs.farcaster.xyz/learn/what-is-farcaster/frames) posted on [x](https://www.x.com) (formerly Twitter).
## What's inside?
This Turborepo includes the following packages/apps:
### Apps and Packages
- `extension`: a [Plasmo](https://www.plasmo.com/) extension
- `server`: a [Next.js](https://nextjs.org/) frames server the extension uses for rendering and interacting with frames
- `@xframes/ui`: a React component library shared by both `server` and `extension` applications
- `@xframes/eslint-config`: `eslint` configurations (includes `eslint-config-turbo` and `eslint-config-prettier`)
- `@xframes/typescript-config`: `tsconfig.json`s used throughout the monorepo
Each package/app is primarily [TypeScript](https://www.typescriptlang.org/).
### Utilities
This Turborepo has some additional tools already setup for you:
- [TypeScript](https://www.typescriptlang.org/) for static type checking
- [ESLint](https://eslint.org/) for code linting
- [Prettier](https://prettier.io) for code formatting
## Extension
TBD - will be added to the appropriate browser extension stores.
## Trying it out yourself
### Prerequisities
Make sure to set all the necessary environment variables for both the [server](/apps/server/README.md) and the [extension](/apps/extension/README.md).
### Build
To build all apps and packages, run the following command:
```
pnpm build
```
### Develop
To develop all apps and packages, run the following command:
```
pnpm dev
```