Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/copilotkit/demo-campaign-manager
https://github.com/copilotkit/demo-campaign-manager
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/copilotkit/demo-campaign-manager
- Owner: CopilotKit
- Created: 2024-03-25T06:52:25.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-07-05T17:33:26.000Z (4 months ago)
- Last Synced: 2024-10-30T03:53:11.851Z (14 days ago)
- Language: TypeScript
- Homepage: https://campaign-manager-demo.vercel.app
- Size: 477 KB
- Stars: 23
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
This is a demo that showcases using CopilotKit to build a PowerPoint like web app.
## Deploy with Vercel
To deploy with Vercel, click the button below:
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FCopilotKit%2Fdemo-campaign-manager&env=NEXT_PUBLIC_COPILOT_CLOUD_API_KEY&project-name=copilotkit-demo-campaign-manager&repository-name=copilotkit-demo-campaign-manager)
## Getting Started
### 1. install the needed package:
```bash
npm i
```
### 2. Set the required environment variables:
copy `.env.local.example` to `.env.local` and populate the required environment variables.
> ⚠️ **Important:** Not all users have access to the GPT-4 model yet. If you don't have access, you can use GPT-3 by setting `OPENAI_MODEL` to `gpt-3.5-turbo` in the `.env.local` file.
### 3. Run the app
```bash
npm run dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
### 4. Use the Copilot
Create a new campaign, or edit an existing campaign, and use the Copilot assistant to configure the form without requiring domain knowledge.
## Zoom in on the CopilotKit code
1. Search for `useCopilotReadable` to see where frontend application information is being made accessible to the Copilot engine
2. Search for `updateCurrentCampaign` and `retrieveHistoricalData` to see where the frontend application action is made accessible to the Copilot engine.
## Learn More
To learn more about CopilotKit, take a look at the following resources:
- [CopilotKit Documentation](https://docs.copilotkit.ai/getting-started/quickstart-chatbot) - learn about CopilotKit features and API.
- [GitHub](https://github.com/CopilotKit/CopilotKit) - Check out the CopilotKit GitHub repository.
- [Discord](https://discord.gg/6dffbvGU3D) - Join the CopilotKit Discord community.