Important Backend Notice:
The backend code (API, database setup, AI service integration) resides in its own repository. Please refer to the LearnAbility Backend Repository for backend setup instructions and code. You will need to have the backend services running for the frontend application to function fully.
Meet LearnAbility – your personalized learning co-pilot! 🧑
Key Ideas:
- 🧠 Personalized Paths: Content adapts to individual learning styles and pace.
- ♿ Accessibility Core: Built with features for visual, auditory, and cognitive accessibility.
- 📱 Mobile First: Delivered through a cross-platform Flutter application.
We aim to provide an equitable and engaging learning experience for every student.
- 🤖 AI Content Generation: Automatically creates lessons, quizzes, and summaries from your uploaded materials (notes, PDFs, etc.).
- 📈 Adaptive Learning: Intelligently adjusts content difficulty and provides personalized feedback based on your progress.
- ♿ Accessibility Suite: Includes high-contrast themes, adjustable text sizes, dyslexia-friendly fonts (like OpenDyslexic), text-to-speech output, and potential for voice navigation.
- 🎮 Interactive Learning: Offers engaging lesson formats, dynamic quizzes, and visual progress tracking to keep you motivated.
- 🔍 Smart Search: Leverages vector search (Milvus) to quickly find the most relevant information within your study materials.
- Frontend: Flutter, Dart 📱
- Backend: Node.js, Express.js, TypeScript ⚙️
- Database: PostgreSQL, Milvus (Vector DB) 💾
- AI: Google Vertex AI (Gemini API, RAG) 🧠
- Validation: Zod (Backend) ✅
- Authentication: JWT 🔑
- Containerization: Docker & Docker Compose (for Backend Services) 🐳
- The application consists of a Flutter frontend communicating with the backend API built with Node.js and written in TypeScript. The backend handles business services logic, data storage, and AI interactions.
- Prisma ORM for PostgreSQL, Milvus for vector search, and Google Vertex AI (Gemini) for AI tasks.
flowchart LR
User[User via Flutter App] --> API[Backend Express API]
API --> Auth[Auth Middleware]
Auth --> Routes[API Routes]
Routes --> Handlers[Request Handlers]
Handlers --> Services[Business Logic Services]
Services --> Gemini[Gemini AI Service]
Services --> Milvus[Milvus Service]
Services --> Prisma[Prisma ORM]
Prisma --> DB[(PostgreSQL DB)]
Milvus --> MilvusDB[(Milvus Vector DB)]
Gemini --> VertexAI[Google Vertex AI]
style API fill:#f9f,stroke:#333,stroke-width:2px
style DB fill:#ccf,stroke:#333,stroke-width:2px
style MilvusDB fill:#cdf,stroke:#333,stroke-width:2px
style VertexAI fill:#fca,stroke:#333,stroke-width:2px
This repository contains the Flutter Frontend for LearnAbility. The backend service is maintained in a separate repository.
Important Backend Notice:
The backend code (API, database setup, AI service integration) resides in its own repository. Please refer to the LearnAbility Backend Repository for backend setup instructions and code. You will need to have the backend services running for the frontend application to function fully.
Frontend Setup:
- Ensure you have the Flutter SDK installed.
- Clone this repository:
git clone https://github.com/0xteamMuffin/LearnAbility.git - Navigate to the project directory:
cd LearnAbility - Install dependencies:
flutter pub get - Ensure the backend services are running (see the Backend Repository for instructions).
- Run the Flutter application:
flutter run(select your target device/emulator).
(Prerequisites: Flutter, Dart, Git. See backend repository for its prerequisites like Node.js, Docker)
- Frontend (This Repository): https://github.com/0xteamMuffin/LearnAbility
- Backend Repository: https://github.com/0xteamMuffin/LearnAbility-backend
- shaunakc11 - Full Stack Developer | AI Engineer
- 0xPixelNinja - Backend Developer
- gaghackz - Frontend and UI/UX Designer
- pranjal-kumar-0 - Frontend and UI/UX Designer
Licensed under the GNU General Public License v3.0.