diff --git a/README.md b/README.md index db09cdf..b2ed955 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,35 @@ -# openaiproject +# OpenAIChatBot 🎡🤖 -To install dependencies: +Welcome to **OpenAIChatBot** — an interactive, customizable chatbot that brings the magic of OpenAI’s APIs to life! This project features a playful virtual assistant designed to delight users with engaging and helpful responses, all powered by configurable prompt engineering. -```bash -bun install -``` +## ✨ What is OpenAIChatBot? -To run: +OpenAIChatBot is a full-stack chatbot experience built in TypeScript, React, and Express, designed for fun themed scenarios. Out of the box, it acts as “Wonder World” theme park’s cheeriest customer support agent — ready to answer questions about rides, shows, dining, tickets, park hours, and more! -```bash -bun run index.ts -``` +The bot uses an OpenAI model and modular prompt injection, making it easy to swap the theme or personality for any use case. All responses are lively, helpful, and always on brand. + +--- + +## 🎢 Features + +- **Conversational AI**: Integrates OpenAI’s GPT models for vivid, context-aware chat. +- **Customizable Personality**: Driven by editable prompt templates (see `packages/server/prompts/`). +- **Persistent Conversations**: Tracks user sessions for smoother, smarter replies. +- **Fun User Experience**: Sound effects, markdown rendering, and a responsive chat UI. +- **Modern Tech Stack**: TypeScript, React, Express, Bun runtime, and modular design. + +--- -This project was created using `bun init` in bun v1.2.21. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime. +## 🚀 Getting Started + +### Prerequisites + +- Node.js or [Bun](https://bun.sh) (preferred) +- An OpenAI API key + +### Installation + +Clone the repository and install dependencies: + +```bash +bun install