{"id":15427713,"url":"https://github.com/farcaster-project/farcaster-gui","last_synced_at":"2025-04-19T16:34:12.712Z","repository":{"id":64844530,"uuid":"565911035","full_name":"farcaster-project/farcaster-gui","owner":"farcaster-project","description":"A next.js based React webapp for interacting with Farcaster Node gRPC daemon.","archived":false,"fork":false,"pushed_at":"2023-09-18T21:35:57.000Z","size":429,"stargazers_count":8,"open_issues_count":4,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-29T10:11:26.080Z","etag":null,"topics":["farcaster","grpc","gui","reactjs","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/farcaster-project.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-14T15:29:18.000Z","updated_at":"2024-10-07T14:58:01.000Z","dependencies_parsed_at":"2024-10-20T08:13:13.527Z","dependency_job_id":null,"html_url":"https://github.com/farcaster-project/farcaster-gui","commit_stats":{"total_commits":106,"total_committers":2,"mean_commits":53.0,"dds":0.06603773584905659,"last_synced_commit":"2db6e06d461c687181b4218d0ef7073511dae7e9"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/farcaster-project%2Ffarcaster-gui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/farcaster-project%2Ffarcaster-gui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/farcaster-project%2Ffarcaster-gui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/farcaster-project%2Ffarcaster-gui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/farcaster-project","download_url":"https://codeload.github.com/farcaster-project/farcaster-gui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249738800,"owners_count":21318504,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["farcaster","grpc","gui","reactjs","typescript"],"created_at":"2024-10-01T18:01:16.140Z","updated_at":"2025-04-19T16:34:12.694Z","avatar_url":"https://github.com/farcaster-project.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build](https://img.shields.io/github/actions/workflow/status/farcaster-project/farcaster-gui/package.yml?branch=main)](https://github.com/farcaster-project/farcaster-gui/blob/main/.github/workflows/package.yml)\n[![Static Analysis](https://img.shields.io/github/actions/workflow/status/farcaster-project/farcaster-gui/analysis.yml?branch=main\u0026label=format)](https://github.com/farcaster-project/farcaster-gui/blob/main/.github/workflows/analysis.yml)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n# Farcaster GUI\n\nThis is the Farcaster Node web application GUI. It allows to interact with your Farcaster Node through the gRPC daemon service. This GUI is built around the Next.js framework, i.e. this is a simple React based web application bundeled as a Docker image.\n\n:mag: You can run this app on your machine or on a server. The server running the app has no access to the node you connect to in the app, only your browser will (and needs access to) your Farcaster Node.\n\nYou can install the node with\n\n```bash\ncargo install farcaster_node\n```\n\nMake sure you have the gRPC service enabled in your `.farcaster/farcasterd.toml` config file\n\n```toml\n[grpc]\nenable = true\nbind_port = 50051\nbind_ip = \"127.0.0.1\"\n```\n\nThen run the app with\n\n```bash\ndocker run --rm -p 3000:3000 ghcr.io/farcaster-project/faracster-gui/app:latest\n```\n\n## Getting Started\n\nFirst install the deps with `npm install` and generate gRPC client files with `npm run gen` (see instructions below), and then run the development server\n\n```bash\nnpm run dev\n# or\nyarn dev\n```\n\nOpen [http://localhost:3000](http://localhost:3000) with your browser to see the result.\n\nThis is tested with node.js version `16`, libprotoc `3.21`, and the code generator plugin [`protoc-gen-grpc-web`](https://github.com/grpc/grpc-web#code-generator-plugin).\n\nGenerated files related to `proto/farcaster.proto` aren't committed, you need to run `npm run gen` to generate them. (You need `protoc` and the code generator plugin [`protoc-gen-grpc-web`](https://github.com/grpc/grpc-web#code-generator-plugin))\n\n## Build and Run the production App\n\nYou can build and run a production version of the app either with a Docker image or on your host.\n\nTo build and run the Docker image\n\n```bash\ndocker build -t farcaster-gui .\ndocker run -p 3000:3000 farcaster-gui\n```\n\n:whale2: The Docker image runs the production application in an Buster Slim Node.js 16 environement.\n\nTo build the production app and run it on your host\n\n```bash\nnpm run build \u0026\u0026 npm run start\n# or\nyarn build \u0026\u0026 yarn start\n```\n\n## Licensing\n\nThe code in this project is licensed under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffarcaster-project%2Ffarcaster-gui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffarcaster-project%2Ffarcaster-gui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffarcaster-project%2Ffarcaster-gui/lists"}