Skip to content

Latest commit

 

History

History
157 lines (107 loc) · 5.59 KB

README.md

File metadata and controls

157 lines (107 loc) · 5.59 KB
Raw

School Bud-E 🎓🤖

School Bud-E Banner

Welcome to School Bud-E, your AI-powered educational assistant! 🚀

Join us on Discord

🌟 Overview

School Bud-E is an intelligent and empathetic learning assistant designed to revolutionize the educational experience. Developed by LAION in collaboration with the ELLIS Institute Tübingen, Collabora, the Tübingen AI Center and the German Research Center for Artificial Intelligence (DFKI), and Intel, School Bud-E focuses on empathy, natural interaction, and personalized learning. A working demo of the application is available at school-bud-e.deno.dev.

🚀 Features (WIP)

  • 💬 Real-time responses to student queries
  • 🧠 Emotionally intelligent interactions
  • 🔄 Continuous conversation context
  • 👥 Multi-speaker and multi-language support
  • 🖥️ Local operation on consumer-grade hardware
  • 🔒 Privacy-focused design

🛠️ Technology Stack

  • Frontend: Fresh framework (Preact-based)
  • Styling: Tailwind CSS
  • Language Support: Internationalization for English and German
  • AI Models:
    • Speech-to-Text: Whisper Large V3 (via Groq API)
    • Large Language Model: GPT-4o or equivalent

🏗️ Project Structure

  • routes/: Application routes
  • components/: Reusable UI components
  • islands/: Interactive components (Fresh islands)
  • internalization/: Language-specific content
  • static/: Static assets

🚀 Getting Started: Development

  1. Clone the repository:

    git clone https://github.com/LAION-AI/school-bud-e.git

  2. Install dependencies:

    deno task start

  3. Set up environment variables:

    • Copy .example.env to .env
    • Fill in the required API keys and endpoints

  4. Run the development server:

    deno task start

  5. Open http://localhost:8000 in your browser

🚀 Getting Started: Production

  1. Without docker

    deno task build
deno task preview

  2. With docker

    git clone https://github.com/LAION-AI/school-bud-e-frontend.git
cd school-bud-e-frontend
cd docker-compose
nano .env # Adjust environment variables accordingly
docker-compose up

Then log into localhost:8000 in your browser.

Interaction Between API Routes and Chat Components

This section describes how the various API routes and chat components interact within the application.

API Routes

  • tts.ts:

    • Description: Handles Text-to-Speech (TTS) requests. It receives text input and returns an audio response.
    • Endpoint: /api/tts
    • Example Usage: Fetching audio data for a given text input.

  • chat.ts:

    • Description: Manages chat messages. It processes incoming chat messages and returns appropriate responses.
    • Endpoint: /api/chat
    • Example Usage: Sending and receiving chat messages.

  • getClientId.ts:

    • Description: Provides a unique client ID for each user session.
    • Endpoint: /api/getClientId
    • Example Usage: Generating a unique identifier for a new chat session.

Chat Components

  • ChatIsland.tsx:

    • Description: Responsible for rendering the chat interface. It interacts with the chat API to send and receive messages.
    • Usage: Uses the client ID obtained from the getClientId API to manage user sessions.
    • Example Usage: Displaying the chat UI and handling user interactions.

  • ChatTemplate.tsx:

    • Description: Serves as a template for the chat interface. It defines the layout and structure of the chat UI.
    • Usage: Used by ChatIsland.tsx to render the chat interface consistently.
    • Example Usage: Providing a consistent layout for the chat interface.

Interaction Flow

  1. When a user opens the chat interface, ChatIsland.tsx requests a unique client ID from the getClientId API.
  2. The user sends a chat message through the chat interface rendered by ChatIsland.tsx.
  3. ChatIsland.tsx sends the message to the chat API endpoint.
  4. The chat API processes the message and returns a streaming response.
  5. ChatIsland.tsx updates the chat interface with the response reflected in ChatTemplate.tsx.
  6. If the user requests a TTS response, ChatIsland.tsx sends the text to the tts API endpoint.
  7. The tts API returns the audio data, which is then played back to the user.

By following this interaction flow, the application ensures a seamless chat experience for users.

For more details, refer to the following files:

  • routes/api/tts.ts
  • routes/api/chat.ts
  • routes/api/getClientId.ts
  • islands/ChatIsland.tsx
  • components/ChatTemplate.tsx

🤝 Contributing

We welcome contributions to School Bud-E! Please join our Discord server or contact us at [email protected] to get involved.

🚧 Experimental Demo Version

Please note that this is an early prototype application that may provide inaccurate answers or generate content that is not suitable for all audiences. We advise caution and encourage you to report any issues you encounter to us.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

🙏 Acknowledgements

Special thanks to LAION, ELLIS Institute Tübingen, Collabora, the Tübingen AI Center and the German Research Center for Artificial Intelligence (DFKI), and Intel for their contributions and support to this project.

Built with ❤️ for the future of education.