Skip to content

Latest commit

ย 

History

23 Commits

Folders and files

NameName
Last commit message
Last commit date
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐ŸŒŸ Aether - Your AI-Powered Study Companion

Flutter Firebase Dart AI

Study smarter, not harder โœจ

Features โ€ข Screenshots โ€ข Tech Stack โ€ข Setup โ€ข Demo


๐ŸŽฏ What is Aether?

Aether is a next-generation study assistant that combines the power of AI with essential productivity tools. Built with Flutter and Firebase, it's your all-in-one platform for acing exams, staying organized, and learning efficiently.

๐Ÿ’ก Fun Fact: "Aether" means the pure essence that the gods breathe in Greek mythology. We believe learning should feel that effortless!


โœจ Features

๐Ÿค– AI Study Tutor

  • Personalized Learning: AI that acts like a real tutor, not just a chatbot
  • Conversation Memory: Remembers your entire conversation for context-aware help
  • Smart Suggestions: Quick-start prompts for math, chemistry, study tips, and more
  • Teaching Style: Guides you to answers instead of just giving them away

๐ŸŽด AI Flashcard Generator

  • Instant Creation: Generate 5-15 flashcards from any topic in seconds
  • Smart Questions: AI creates understanding-based questions, not just facts
  • Manual Mode: Full control with traditional card-by-card creation
  • Study Ready: Save and study immediately

โœ… Smart To-Do List

  • Priority Levels: Color-coded tasks (low, medium, high)
  • Due Dates: Never miss a deadline with date/time reminders
  • Real-time Sync: Tasks update instantly across devices
  • Quick View: See your top 3 upcoming tasks on the home screen

โฑ๏ธ Focus Timer

  • Customizable Sessions: 1-120 minutes (default: 25 min Pomodoro)
  • Progress Tracking: All study sessions saved to your profile
  • Daily Goals: Set and track daily study time targets
  • Visual Progress: Circular timer with smooth animations

๐Ÿ“š Flashcard System

  • Create Decks: Manual or AI-generated flashcards
  • Study Mode: Flip cards, mark as learned, track progress
  • Score Tracking: See how many cards you got right
  • Organized: All decks in one place with card counts

๐Ÿ‘ค Profile & Stats

  • Study Analytics: Total study time, completed tasks, decks created
  • Daily Goals: Set and track daily study targets with progress bars
  • Personal Info: Add bio, education, hobbies, and more
  • About Me Card: Showcase your profile on the home screen

๐ŸŽจ Beautiful Design

  • Neo-Brutalist UI: Bold borders, vibrant colors, modern aesthetics
  • Dark Mode: Easy on the eyes for late-night study sessions
  • Smooth Animations: Polished transitions and loading states
  • Responsive: Works on Android, Web, and more

๐Ÿ” Secure Authentication

  • Email/Password: Traditional sign-up with strict validation
  • Google Sign-In: One-tap authentication
  • Password Reset: Easy recovery via email
  • Persistent Sessions: Stay logged in across app restarts

๐Ÿ“ฑ Screenshots

Home & Chat

Home Screen AI Chat Chat History
Home Chat History

Flashcards & Productivity

Deck List AI Generate Tasks
Decks Generate Tasks

Timer & Profile

Focus Timer Profile
Timer Profile

๐Ÿ› ๏ธ Tech Stack

Frontend

  • Flutter 3.0+ - Cross-platform UI framework
  • Dart - Programming language
  • Provider - State management
  • Google Fonts - Plus Jakarta Sans typography

Backend & Services

  • Firebase Auth - User authentication (Email + Google)
  • Cloud Firestore - Real-time NoSQL database
  • Groq API - AI chat & flashcard generation (llama-3.3-70b)

Architecture

  • Clean Architecture - Separation of concerns
  • Repository Pattern - Data abstraction
  • Provider Pattern - State management
  • Service Layer - API integrations

Key Packages

firebase_core: ^3.10.0
firebase_auth: ^5.3.4
cloud_firestore: ^5.5.2
google_sign_in: ^6.2.2
http: ^1.2.2
flutter_dotenv: ^5.2.1
google_fonts: ^6.2.1
intl: ^0.20.1
shared_preferences: ^2.3.4

๐Ÿš€ Quick Start

Prerequisites

  • Flutter SDK 3.0+
  • Android Studio / VS Code
  • Firebase account (free)
  • Groq API key (free)

Installation

  1. Clone the repository

    git clone https://github.com/MajidFQ/Aether.git
    cd aether
  2. Install dependencies

    flutter pub get
  3. Configure Firebase

    # Install Firebase CLI
    npm install -g firebase-tools
    
    # Login to Firebase
    firebase login
    
    # Configure project
    flutterfire configure
  4. Set up Groq API

    # Copy template
    cp assets/.env.example assets/.env
    
    # Edit assets/.env and add your key
    GROQ_API_KEY=your_key_here

    Get your free key at: https://console.groq.com/keys

  5. Run the app

    flutter run

๐Ÿ“– Detailed setup instructions: See SETUP.md


๐ŸŽฎ Demo

Download & Try!

๐Ÿ“ฑ Android APK: Download v1.0.0 (56.9 MB)

๐ŸŒ Web Demo: Coming soon!

Installation Instructions

  1. Download the APK file from the link above
  2. On your Android device, go to Settings โ†’ Security
  3. Enable "Install from Unknown Sources" or "Install Unknown Apps"
  4. Open the downloaded APK file
  5. Tap "Install" and wait for installation to complete
  6. Launch Aether and create your account!

Minimum Requirements: Android 5.0 (API 21) or higher

Video Walkthrough

Coming soon!


๐Ÿ—๏ธ Project Structure

lib/
โ”œโ”€โ”€ main.dart                    # App entry point
โ”œโ”€โ”€ firebase_options.dart        # Firebase config (not in repo)
โ”‚
โ”œโ”€โ”€ models/                      # Data models
โ”‚   โ””โ”€โ”€ task_model.dart
โ”‚
โ”œโ”€โ”€ providers/                   # State management
โ”‚   โ””โ”€โ”€ theme_provider.dart
โ”‚
โ”œโ”€โ”€ screens/                     # UI screens
โ”‚   โ”œโ”€โ”€ auth/                    # Login, Register
โ”‚   โ”œโ”€โ”€ home/                    # Dashboard
โ”‚   โ”œโ”€โ”€ chat/                    # AI Chat, History
โ”‚   โ”œโ”€โ”€ flashcards/              # Decks, Create, Study
โ”‚   โ”œโ”€โ”€ timer/                   # Focus Timer
โ”‚   โ”œโ”€โ”€ tasks/                   # To-Do List
โ”‚   โ””โ”€โ”€ profile/                 # Profile, Edit
โ”‚
โ”œโ”€โ”€ services/                    # API services
โ”‚   โ”œโ”€โ”€ auth_service.dart        # Firebase Auth
โ”‚   โ””โ”€โ”€ groq_service.dart        # AI API
โ”‚
โ”œโ”€โ”€ utils/                       # Helpers
โ”‚   โ””โ”€โ”€ theme_helper.dart
โ”‚
โ””โ”€โ”€ widgets/                     # Reusable components
    โ”œโ”€โ”€ custom_text_field.dart
    โ””โ”€โ”€ social_button.dart

assets/
โ””โ”€โ”€ .env                         # API keys (not in repo)

docs/
โ”œโ”€โ”€ PROJECT_REPORT.md            # Full documentation
โ”œโ”€โ”€ AI_FEATURES_PROOF.md         # AI implementation details
โ””โ”€โ”€ SETUP.md                     # Setup guide

๐ŸŽจ Design Philosophy

Neo-Brutalism

Aether embraces neo-brutalist design - a modern aesthetic characterized by:

  • Bold borders (2px solid black)
  • Offset shadows (no blur, pure offset)
  • Vibrant colors (Purple #5B4FFF primary)
  • Clear hierarchy (typography-driven)
  • Honest UI (no skeuomorphism, no gradients)

Color Palette

Primary:    #5B4FFF (Purple)
Background: #F5F5F7 (Light Gray)
Card:       #FFFFFF (White)
Border:     #000000 (Black)
Text:       #000000 (Black)
Muted:      #6B6B70 (Gray)

๐Ÿ”’ Security

  • โœ… API keys stored in .env (not committed)
  • โœ… Firebase config excluded from git
  • โœ… Firestore security rules (user-scoped data)
  • โœ… Email validation (strict format checking)
  • โœ… Password requirements (6+ chars, letter + number)
  • โœ… Template files provided for setup

See: SECURITY_CLEANUP.md


๐Ÿ“Š Features Breakdown

Feature Status Description
๐Ÿค– AI Chat โœ… Complete Personalized study tutor with memory
๐ŸŽด AI Flashcards โœ… Complete Generate cards from topics
โœ… To-Do List โœ… Complete Priority tasks with due dates
โฑ๏ธ Focus Timer โœ… Complete Customizable Pomodoro timer
๐Ÿ“š Flashcards โœ… Complete Manual creation & study mode
๐Ÿ‘ค Profile โœ… Complete Stats, goals, personal info
๐ŸŽจ Dark Mode โœ… Complete System-wide theme toggle
๐Ÿ” Auth โœ… Complete Email + Google Sign-In
๐Ÿ’พ Chat History โœ… Complete Save & reopen conversations
๐Ÿ“ฑ Responsive โœ… Complete Android + Web support

๐Ÿค Contributing

We welcome contributions! Here's how:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Please read: CONTRIBUTING.md (Coming soon)


๐Ÿ“ License

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


๐Ÿ‘ฅ Team

Developed by: Majid Farooq Qureshi

Course: Mobile Application Development

Institution: [COMSATS Islamabad]

Year: 2026


๐Ÿ™ Acknowledgments

  • Flutter Team - Amazing framework
  • Firebase - Backend infrastructure
  • Groq - Free AI API access
  • Google Fonts - Beautiful typography
  • Icons8 - UI inspiration

๐Ÿ“ž Contact

Have questions? Reach out!


๐ŸŒŸ Star History

Star History Chart


Made with โค๏ธ and lots of โ˜•

If you found this project helpful, consider giving it a โญ!

โฌ† Back to Top

About

๐ŸŒŸ AI-powered study companion app built with Flutter & Firebase. Features AI chat tutor, flashcard generator, smart to-do list, focus timer, and dark mode. Study smarter, not harder! ๐Ÿ“šโœจ

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages