{"id":24531507,"url":"https://github.com/charlesw-salesforce/sample-agentforce-custom-client","last_synced_at":"2025-04-14T19:13:00.078Z","repository":{"id":271931731,"uuid":"912899398","full_name":"charlesw-salesforce/sample-agentforce-custom-client","owner":"charlesw-salesforce","description":"This is a custom Agentforce Service Agent UI that uses Salesforce's Messaging for In-App and Web APIs.","archived":false,"fork":false,"pushed_at":"2025-01-22T03:55:36.000Z","size":1144,"stargazers_count":13,"open_issues_count":0,"forks_count":5,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-14T19:12:54.228Z","etag":null,"topics":["agentforce","agents","fastify","reactjs","salesforce","salesforce-api","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/charlesw-salesforce.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":"2025-01-06T16:12:25.000Z","updated_at":"2025-03-19T21:33:18.000Z","dependencies_parsed_at":"2025-01-22T04:26:44.830Z","dependency_job_id":null,"html_url":"https://github.com/charlesw-salesforce/sample-agentforce-custom-client","commit_stats":null,"previous_names":["charlesw-salesforce/sample-agentforce-custom-client"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charlesw-salesforce%2Fsample-agentforce-custom-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charlesw-salesforce%2Fsample-agentforce-custom-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charlesw-salesforce%2Fsample-agentforce-custom-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charlesw-salesforce%2Fsample-agentforce-custom-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/charlesw-salesforce","download_url":"https://codeload.github.com/charlesw-salesforce/sample-agentforce-custom-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248943461,"owners_count":21186958,"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":["agentforce","agents","fastify","reactjs","salesforce","salesforce-api","typescript"],"created_at":"2025-01-22T09:15:15.602Z","updated_at":"2025-04-14T19:13:00.046Z","avatar_url":"https://github.com/charlesw-salesforce.png","language":"TypeScript","readme":"# Agentforce Custom Chat Client\n\nA modern React-based chat interface implementation for Salesforce's Messaging for In-App and Web APIs, designed to work with Agentforce Service Agents. Built with React, TypeScript, Tailwind CSS, and Fastify.\n\n[🎥 Watch the Demo Video](https://youtu.be/Ip2d_jay7H0?si=W3kMhn1-fKOKAn_X)\n\n![Screenshot of chat interface](./media/custom-client-demo.gif)\n\n## Features\n\n- 💬 Real-time messaging using Server-Sent Events (SSE)\n- 📝 Live typing indicators\n- 🎙️ Voice input support with speech recognition\n- 🌓 Light/dark theme support\n- 📱 Fully responsive design\n\n## Prerequisites\n\n- Node.js \u003e= 20.0.0\n- pnpm \u003e= 8.x\n- A Salesforce org with Messaging for In-App and Web configured\n- An Agentforce Service Agent deployment\n\n## Quick Start\n\n1. Clone the repository:\n\n```bash\ngit clone https://github.com/charlesw-salesforce/agentforce-custom-client.git\ncd agentforce-custom-client\n```\n\n2. Install dependencies:\n\n```bash\npnpm install\n```\n\n3. Configure environment variables:\n\n```bash\ncd server\ncp .env.example .env\n```\n\nUpdate `.env` with your Salesforce credentials:\n\n```env\nSALESFORCE_SCRT_URL=your-scrt-url\nSALESFORCE_ORG_ID=your-org-id\nSALESFORCE_DEVELOPER_NAME=your-developer-name\nPORT=8080\n```\n\n4. Start development servers:\n\n```bash\n# Start both client and server\npnpm dev\n\n# Or start individually:\npnpm dev:client   # Client at http://localhost:5173\npnpm dev:server   # Server at http://localhost:8080\n```\n\n## Available Scripts\n\n- `pnpm dev` - Start both client and server in development mode\n- `pnpm dev:client` - Start client development server\n- `pnpm dev:server` - Start backend development server\n- `pnpm build` - Build both client and server\n- `pnpm start` - Start production server\n\n## Environment Variables\n\n### Server\n\n| Variable                    | Description                 | Required |\n| --------------------------- | --------------------------- | -------- |\n| `SALESFORCE_SCRT_URL`       | Salesforce SCRT URL         | Yes      |\n| `SALESFORCE_ORG_ID`         | Salesforce Organization ID  | Yes      |\n| `SALESFORCE_DEVELOPER_NAME` | Salesforce Developer Name   | Yes      |\n| `PORT`                      | Server port (default: 8080) | No       |\n\n### Client\n\n| Variable       | Description     | Required |\n| -------------- | --------------- | -------- |\n| `VITE_API_URL` | Backend API URL | Yes      |\n\n## Setting Up Your Salesforce Organization\n\n1. Create and deploy an Agentforce Service Agent ([video tutorial](https://www.youtube.com/live/1vuZfPEtuUM?si=lQKYsVE9PQrEICNA))\n2. [Create a Custom Client](https://help.salesforce.com/s/articleView?id=service.miaw_deployment_custom.htm\u0026type=5) deployment using your messaging channel\n3. Copy the SCRT URL, Org ID, and Developer Name to your `.env` file\n\nFor detailed setup instructions, follow the [Salesforce documentation](https://help.salesforce.com/s/articleView?id=service.miaw_deployment_custom.htm\u0026type=5).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcharlesw-salesforce%2Fsample-agentforce-custom-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcharlesw-salesforce%2Fsample-agentforce-custom-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcharlesw-salesforce%2Fsample-agentforce-custom-client/lists"}