https://github.com/khaledsaeed18/yalla-learn
Yalla Learn - 💻 Website
https://github.com/khaledsaeed18/yalla-learn
ai ai-sdk axios framer-motion frontend nextjs pnpm react-hook-form reactjs redux server-actions shadcn-ui tailwindcss typescript vercel zod
Last synced: 5 days ago
JSON representation
Yalla Learn - 💻 Website
- Host: GitHub
- URL: https://github.com/khaledsaeed18/yalla-learn
- Owner: KhaledSaeed18
- License: mit
- Created: 2025-03-01T18:21:13.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-06-22T18:30:33.000Z (4 months ago)
- Last Synced: 2025-06-22T19:34:23.153Z (4 months ago)
- Topics: ai, ai-sdk, axios, framer-motion, frontend, nextjs, pnpm, react-hook-form, reactjs, redux, server-actions, shadcn-ui, tailwindcss, typescript, vercel, zod
- Language: TypeScript
- Homepage: https://www.yalla-learn.me/
- Size: 2.07 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 🚀 Yalla Learn - Complete Learning & Productivity Platform
[](https://yalla-learn.me)
[](https://nextjs.org/)
[](https://reactjs.org/)
[](https://www.typescriptlang.org/)
[](https://tailwindcss.com/)
[](https://opensource.org/licenses/MIT)
**A comprehensive learning and productivity platform powered by AI, designed to enhance your educational journey and boost productivity.**
[🌐 Live Demo](https://yalla-learn.me) • [📱 Mobile App](#-related-repositories) • [🖥️ Desktop App](#-related-repositories) • [🔧 Backend API](#-related-repositories)
---
## 📋 Table of Contents
- [✨ Features](#-features)
- [🎯 AI Tools](#-ai-tools)
- [⚡ Productivity Tools](#-productivity-tools)
- [🔧 Tech Stack](#-tech-stack)
- [🚀 Installation](#-installation)
- [📖 Usage](#-usage)
- [🔗 Related Repositories](#-related-repositories)
- [🤝 Contributing](#-contributing)
- [📄 License](#-license)
---
## ✨ Features
### 🤖 **AI-Powered Learning Tools**
| Feature | Description | Status |
|---------|-------------|--------|
| 📄 **PDF AI Chat** | Chat with PDFs - summarize, search and extract information instantly | ✅ |
| 🖼️ **Image AI Chat** | Upload images and chat with AI to explore, analyze, and understand them | ✅ |
| 🧠 **Mindmap Creation** | Turn ideas into clear, visual mindmaps in seconds with AI | ✅ |
| 🃏 **Flashcard Generation** | Generate flashcards from any text or topic for effective learning | ✅ |
| 📚 **Study Plan Generator** | Create personalized study plans based on subject, timeframe, and goals | ✅ |
| 📝 **Quiz Generator** | Create interactive quizzes with automatic scoring and explanations | ✅ |
| 🧩 **Concept Explainer** | Get clear explanations of complex concepts with visual descriptions | ✅ |
| 🔍 **AI Web Search** | Search the web using AI and get relevant, curated results | ✅ |
| 🎤 **Voice Assistant** | Have voice conversations with AI for learning support | ✅ |
### ⚡ **Productivity & Management Tools**
| Feature | Description | Status |
|---------|-------------|--------|
| ⏰ **Pomodoro Timer** | Enhanced focus with customizable 25/5 minute timer cycles | ✅ |
| 🎯 **Focus Mode** | Distraction-free environment for maximum concentration | ✅ |
| 📄 **Resume Builder** | Professional resume creation with multiple templates | ✅ |
| 💰 **Expense Tracker** | Personal finance management with charts and analytics | ✅ |
| 📋 **Kanban Board** | Task management with drag-and-drop functionality | ✅ |
### 💬 **Community & Content**
| Feature | Description | Status |
|---------|-------------|--------|
| ❓ **Q&A Platform** | Ask questions and get answers from the community | ✅ |
| 📝 **Blog System** | Rich content creation and sharing platform | ✅ |
| 💼 **Job Portal** | Career opportunities and job listings | ✅ |
---
## 🎯 AI Tools
### 🤖 Powered by Advanced AI Models
Our AI tools are designed to revolutionize your learning experience:
- **📄 PDF AI Chat**: Upload PDFs and have intelligent conversations about the content
- **🖼️ Image AI Chat**: Analyze images, get descriptions, and ask questions about visual content
- **🧠 Mindmap Creation**: Transform complex topics into visual mindmaps automatically
- **🃏 Flashcard Generation**: Create study cards from any topic with AI-generated questions
- **📚 Study Plan Generator**: Get personalized learning schedules based on your goals
- **📝 Quiz Generator**: Generate quizzes with explanations for any subject
- **🧩 Concept Explainer**: Break down complex concepts into understandable explanations
- **🔍 AI Web Search**: Get curated, relevant search results with AI analysis
- **🎤 Voice Assistant**: Natural voice conversations for learning support
---
## ⚡ Productivity Tools
Boost your efficiency with our specialized productivity features:
### 🎯 **Focus Enhancement**
- **Pomodoro Timer**: Customizable work/break cycles
- **Focus Mode**: Distraction-free workspace
- **Progress Tracking**: Monitor your productivity sessions
### 📊 **Organization Tools**
- **Task Management**: Kanban-style boards with drag-and-drop
- **Expense Tracking**: Personal finance management with analytics
- **Resume Builder**: Professional CV creation with multiple templates
---
## 🔧 Tech Stack
### Frontend
### State Management & UI
### AI & APIs
### Development Tools
---
## 🚀 Installation
### 📋 Prerequisites
| Requirement | Version | Download |
|-------------|---------|----------|
| **Node.js** | v20+ | [Download](https://nodejs.org/) |
| **Git** | Latest | [Download](https://git-scm.com/) |
| **PNPM** | Latest | [Install](https://pnpm.io/installation) |
### 🛠️ Setup Instructions
1. **Clone the repository**
```bash
git clone https://github.com/KhaledSaeed18/yalla-learn.git
cd yalla-learn
```
2. **Install dependencies**
```bash
pnpm install
```
3. **Environment Setup**
```bash
# Add your API keys and configuration
# Edit .env.local with your actual values
```
4. **Start development server**
```bash
pnpm dev
```
5. **Open your browser**
```
http://localhost:3000
```
### 🔑 Environment Variables
Create a `.env.local` file with the following variables:
```env
GOOGLE_GENERATIVE_AI_API_KEY=
NEXT_PUBLIC_HUGGINGFACE_API_KEY=
NEXT_PUBLIC_AZURE_TRANSLATOR_KEY=
NEXT_PUBLIC_AZURE_TRANSLATOR_REGION=
NEXT_PUBLIC_API_URL=
NEXT_PUBLIC_VAPI_API_KEY=
```
---
## 📖 Usage
### 🎯 **Getting Started**
1. **Sign up** for a new account or **sign in** if you already have one
2. **Explore AI Tools** - Start with PDF chat or concept explainer
3. **Set up productivity** - Configure your Pomodoro timer and create task boards
4. **Join the community** - Ask questions in Q&A and read blog posts
5. **Build your profile** - Use the resume builder and track your progress
### 🔧 **Development Commands**
| Command | Description | Usage |
|---------|-------------|--------|
| `pnpm dev` | Start development server with Turbopack | Development |
| `pnpm build` | Build production bundle | Deployment |
| `pnpm start` | Start production server | Production |
| `pnpm lint` | Run ESLint for code quality | Code Quality |
---
## 🔗 Related Repositories
### 🌐 **Complete Yalla Learn Ecosystem**
| Platform | Repository | Description | Technology |
|----------|------------|-------------|------------|
| 🌐 **Frontend Web** | [yalla-learn](https://github.com/KhaledSaeed18/yalla-learn) | Main web application (this repo) | Next.js, React, TypeScript |
| 🔧 **Backend API** | [yalla-learn-backend](https://github.com/KhaledSaeed18/yalla-learn-backend) | RESTful API and database | Node.js, Express, PostgresSQL |
| 📱 **Mobile App** | [yalla-learn-app](https://github.com/KhaledSaeed18/yalla-learn-app) | iOS & Android application | React Native, Expo |
| 🖥️ **Desktop App** | [yalla-learn-desktop](https://github.com/KhaledSaeed18/yalla-learn-desktop) | Cross-platform desktop app | Electron, React |
---
## 🌟 Features Showcase
### 📊 **Dashboard Overview**
- **AI Assistant**: Integrated chat for learning support
- **Progress Tracking**: Monitor your learning journey
- **Quick Access**: Fast navigation to all tools and features
- **Personalization**: Customizable workspace and preferences
### 🎨 **User Experience**
- **Responsive Design**: Works perfectly on all devices
- **Dark/Light Mode**: Theme switching for comfortable viewing
- **Accessibility**: WCAG compliant for inclusive design
- **Performance**: Optimized with Next.js and Turbopack
### 🔒 **Security & Privacy**
- **Secure Authentication**: JWT-based user management
- **Data Encryption**: Protected user data and conversations
- **Privacy Controls**: Granular privacy settings
- **GDPR Compliant**: Respects user data rights
---
## 🤝 Contributing
We welcome contributions from the community! Here's how you can help:
### 🚀 **How to Contribute**
1. **Fork the repository**
2. **Create a feature branch** (`git checkout -b feature/amazing-feature`)
3. **Commit your changes** (`git commit -m 'Add amazing feature'`)
4. **Push to the branch** (`git push origin feature/amazing-feature`)
5. **Open a Pull Request**
### 📝 **Contribution Guidelines**
- Follow the existing code style and conventions
- Write clear commit messages
- Add tests for new features
- Update documentation as needed
- Ensure all tests pass before submitting
---
## 📄 License
This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.
[](https://github.com/KhaledSaeed18/yalla-learn/stargazers)
[](https://github.com/KhaledSaeed18/yalla-learn/network/members)
[🌐 Website](https://yalla-learn.me)