https://github.com/akazwz/workersai
a LLMs/AI chat platform build and design for Cloudflare worker AI. with many features like function calling, image to text, text to image, text to speech
https://github.com/akazwz/workersai
ai chatbot cloudflare cloudflare-workers remix worker
Last synced: 14 days ago
JSON representation
a LLMs/AI chat platform build and design for Cloudflare worker AI. with many features like function calling, image to text, text to image, text to speech
- Host: GitHub
- URL: https://github.com/akazwz/workersai
- Owner: akazwz
- Created: 2024-07-14T06:13:22.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-14T15:42:54.000Z (about 1 year ago)
- Last Synced: 2025-01-09T13:15:01.444Z (9 months ago)
- Topics: ai, chatbot, cloudflare, cloudflare-workers, remix, worker
- Language: TypeScript
- Homepage: https://worker.antonai.com
- Size: 1.23 MB
- Stars: 61
- Watchers: 1
- Forks: 13
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cloudflare AI Chat Demo
[](https://deploy.workers.cloudflare.com/?url=https://github.com/akazwz/workersai/tree/main/backend)
Live Demo: [workersai.zwz.workers.dev](https://workersai.zwz.workers.dev/)
This is a demo project showcasing a full-stack chat application built entirely on the Cloudflare stack, featuring AI capabilities.
## Features
* **AI-Powered Chat:** Engage in conversations powered by Cloudflare AI text generation models.
* **Real-time Communication:** Uses WebSockets via Cloudflare Durable Objects for instant message delivery.
* **Text-to-Speech (TTS):** Hear AI responses spoken aloud using Cloudflare AI TTS.
* **Speech-to-Text (STT):** Dictate your messages using Cloudflare AI STT (Whisper).
* **Conversation Management:** Create, rename, pin, and delete conversations.
* **Model Selection:** View available Cloudflare AI text generation models.
* **Anonymous Sessions:** Simple authentication using tokens stored in Cloudflare KV.
* **Modern Tech Stack:**
* **Backend:** Cloudflare Workers, Durable Objects, KV, AI Gateway, TypeScript, ConnectRPC, Drizzle ORM (potentially for future database integration).
* **Frontend:** React, TypeScript, Vite, TailwindCSS, React Router.
* **API:** Protocol Buffers (protobuf) for type-safe communication.
## Project Structure
```
.
├── backend/ # Cloudflare Worker backend code (TypeScript)
├── frontend/ # React frontend application (TypeScript, Vite)
├── proto/ # Protocol Buffer definitions for the API
├── buf.gen.yaml # Buf code generation configuration
├── buf.yaml # Buf linting and breaking change detection configuration
├── deploy.sh # Deployment script (likely for Cloudflare Workers)
└── README.md # This file
```
## Getting Started
*(Instructions need to be added here based on how to set up environment variables, install dependencies for both frontend and backend, and run the development servers.)*
### Prerequisites
* Node.js and pnpm
* Cloudflare Account
* Wrangler CLI
* Buf CLI (optional, for protobuf generation)
### Setup
1. **Clone the repository:**
```bash
git clone https://github.com/akazwz/workersai.git
cd workersai
```
2. **Install Dependencies:**
```bash
# From the root directory
pnpm install
# Navigate to backend and frontend to ensure all deps are installed if needed
cd backend && pnpm install
cd ../frontend && pnpm install
cd ..
```
3. **Configure Backend Environment Variables:**
* Navigate to the `backend` directory.
* Copy the provided example environment file: `cp .dev.vars.example .dev.vars`
* Edit `.dev.vars` and fill in your Cloudflare credentials and bindings (refer to `wrangler.jsonc` for required variables).
* Return to the project root directory: `cd ..`
4. **Configure Frontend Environment Variables:**
* The `frontend` directory now includes a `.env` file with default/example settings.
* For local development, it is recommended to copy this file to `.env.local` within the `frontend` directory:
```bash
cp frontend/.env frontend/.env.local
```
* Then, customize `frontend/.env.local` with your specific settings (e.g., `VITE_API_URL` if it needs to differ from the default). The `.env.local` file will override `frontend/.env` and is typically gitignored.
* If you don't create a `.env.local`, ensure the values in `frontend/.env` are suitable for your local setup.
5. **Build Frontend Assets:**
```bash
cd frontend
pnpm run build
cd ..
```
6. **Configure Cloudflare Resources:**
* Set up necessary Cloudflare resources (KV namespace, Durable Object binding, AI Gateway). This step might involve using the Cloudflare dashboard or Wrangler commands. Ensure the bindings in `backend/wrangler.jsonc` and `.dev.vars` match these resources.
7. **Generate Protobuf Code (if needed):**
```bash
buf generate
```
### Running Locally
**Important:** Before starting the backend worker, ensure you have:
1. Configured your `backend/.dev.vars` file (as per **Setup step 3**).
2. Configured your frontend environment by checking/copying `frontend/.env` to `frontend/.env.local` and customizing it if needed (as per **Setup step 4**).
3. Built the frontend assets (as per **Setup step 5**):
```bash
# Ensure you are in the project root directory
cd frontend
pnpm run build
cd ..
```
These steps are crucial for the application to run correctly.
1. **Start the backend worker (using Wrangler):**
```bash
cd backend
pnpm run dev
```
2. **Start the frontend development server (optional, if you want to make frontend changes and see them live):**
```bash
cd frontend
pnpm run dev
```
The application should now be accessible (usually at `http://localhost:8787` for the backend worker, which serves the frontend assets. If you run the frontend dev server, it's often at `http://localhost:5173`).
## Deployment
*(Instructions need to be added here, likely involving running the `deploy.sh` script or using `wrangler deploy`.)*
```bash
# Example deployment command (adapt as needed)
./deploy.sh
# or
# cd backend && wrangler deploy
```
## Contributing
Contributions are welcome! Please feel free to submit issues or pull requests.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.