https://github.com/romabulani/learnbot
JavaScript AI Teacher
https://github.com/romabulani/learnbot
ai genai js react tailwindcss typescript websocket
Last synced: 3 months ago
JSON representation
JavaScript AI Teacher
- Host: GitHub
- URL: https://github.com/romabulani/learnbot
- Owner: romabulani
- License: mit
- Created: 2025-01-20T02:59:46.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-20T03:54:35.000Z (5 months ago)
- Last Synced: 2025-01-27T07:14:59.096Z (5 months ago)
- Topics: ai, genai, js, react, tailwindcss, typescript, websocket
- Language: TypeScript
- Homepage: https://learnbot-js.vercel.app
- Size: 63.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JavaScript AI Teacher - Frontend
## Overview
This is the frontend implementation for the JavaScript AI Teacher application. It provides a clean and user-friendly interface for interacting with the backend services. Users can log in, sign up, or access the application as a guest to chat with the AI teacher, who specializes in JavaScript.
---
## Features
- **Home Page**: Introduction to the app and navigation options.
- **Authentication**:
- Sign Up: Create a new account.
- Login: Access the application with registered credentials.
- Guest Login: Explore the app without creating an account.
- **1-on-1 Chat Interface**:
- Engage in real-time chat with the AI teacher.
- Streaming-based response rendering for a conversational feel.
- **WebSocket Integration**: Supports chunk-based message appending for smooth and incremental responses.
---
## Technologies Used
- **React** (with TypeScript): Frontend framework for building UI components.
- **Tailwind CSS**: Utility-first CSS framework for styling.
- **WebSocket**: Enables real-time communication for chat functionality.
---
## Setup and Installation
### Prerequisites
- Node.js (v16 or above)
- npm or yarn
### Steps to Run the Frontend Locally
1. Clone the repository:
```bash
git clone https://github.com/romabulani/learnbot
cd learnbot
```
2. Install dependencies and run:
```bash
npm install
npm run dev
```
---
## Deployment
The app is deployed on Vercel. You can try it out at: [https://learnbot-js.vercel.app/](https://learnbot-js.vercel.app/)
---
## Known Issues
Typing Issue: Some characters may be missing during typewriting animation. This will be addressed in future updates.
---
## License
This project is licensed under the MIT License.