📝 Nota

AI-Powered Smart Notes & Diary Application

🌟 Features • 📦 Installation • 📸 Screenshots • 🛠️ Tech Stack • 🤝 Contributing • 📄 Docs

Transform your thoughts into organized actions with AI ✨

🌟 Overview

Nota is a revolutionary AI-powered notes and diary application that transforms how you capture and organize your thoughts. Simply input via text, voice, or camera, and watch as our intelligent AI engine automatically categorizes your content into meaningful sections.

🇸🇦 Full Arabic RTL Support - Designed with Arabic users in mind, featuring beautiful Tajawal fonts and right-to-left layouts.

🎯 What Makes Nota Special?

🤖 AI-Powered Intelligence

Automatically categorizes notes using Gemini 2.5 Flash - Google's latest AI model. Just type naturally and let AI do the organizing.

🎤 Multi-Input Support

Input via text, voice recording, or camera capture. Perfect for capturing thoughts on the go.

📊 Smart Organization

Automatically sorts into Tasks, Appointments, Expenses, and Personal Notes with smart extraction of dates, amounts, and priorities.

🔐 Secure Authentication

6 login methods: Email, Google, Facebook, GitHub, Apple, and Biometric (Fingerprint/Face ID).

🌙 Beautiful Modern UI

Sleek design with smooth animations, haptic feedback, and Material 3 design language.

☁️ Real-time Cloud Sync

All data synced with Firebase in real-time. Access from any device, anytime.

✨ Features

📱 Core Features

📝 Smart Notes _{Create notes that are automatically categorized by AI}	✅ Tasks & To-Dos _{Manage tasks with priorities, due dates, and subtasks}	📅 Appointments _{Schedule and track with calendar integration}
💰 Expense Tracking _{Log expenses with categories and amounts}	🔍 Smart Search _{Find anything instantly with intelligent search}	📊 Dashboard _{Beautiful overview of all your content}

🔐 Authentication Methods

Method	Status	Description
✉️ Email/Password	✅	Traditional email authentication with verification
🔵 Google	✅	One-tap Google Sign-In
📘 Facebook	✅	Facebook OAuth integration
🐙 GitHub	✅	GitHub OAuth for developers
🍎 Apple	✅	Sign in with Apple (iOS/macOS)
👆 Biometric	✅	Fingerprint & Face ID support

🎤 Smart Input Methods

┌─────────────────────────────────────────────────────────────────┐
│                                                                 │
│   ⌨️ TEXT          🎙️ VOICE         📷 CAMERA        🖼️ GALLERY  │
│   ──────          ─────          ──────        ───────  │
│   Type your       Speak and      Capture       Import   │
│   thoughts        transcribe     receipts      images   │
│   naturally       instantly      & docs        for AI   │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

🤖 AI Capabilities (Gemini 2.5 Flash)

Capability	Description
🏷️ Auto-Categorization	Notes → Tasks, Appointments, Expenses, or Personal
📅 Date Extraction	Automatically detects dates like "غداً" or "next Monday"
💵 Amount Detection	Extracts currency and amounts from text
⚡ Priority Analysis	Detects urgency from context
🌍 Bilingual Support	Understands Arabic & English naturally
🧠 Context Awareness	Learns from your usage patterns

📸 Screenshots

🔐 Authentication Flow

Splash Screen	Login	Register	Forgot Password

📱 Main App

Dashboard	AI Input	Tasks	Appointments	Quotes	Track Money

🛠️ Tech Stack

Frontend & UI

Technology	Version	Purpose
	3.3+	Cross-platform UI framework
	3.0+	Programming language
	Latest	Design system
	-	Tajawal Arabic font

Backend & Cloud Services

Technology	Purpose
	Multi-provider authentication
	Real-time NoSQL database
	Image & file storage
	Media management CDN

AI & Machine Learning

Technology	Model	Purpose
	2.5 Flash	AI categorization & extraction
	-	Voice transcription

Key Packages

dependencies:
  # Firebase Suite
  firebase_core: ^3.8.0
  firebase_auth: ^5.3.3
  cloud_firestore: ^5.5.0
  firebase_storage: ^12.4.10
  
  # Social Authentication
  google_sign_in: ^6.2.2
  flutter_facebook_auth: ^7.1.1
  local_auth: ^2.3.0  # Biometric
  
  # AI Integration
  google_generative_ai: ^0.4.7
  speech_to_text: ^7.3.0
  
  # UI & Animations
  flutter_animate: ^4.5.0
  lottie: ^3.1.3
  google_fonts: ^6.3.0
  
  # Media & Input
  camera: ^0.10.3
  image_picker: ^1.1.1

📦 Installation

📋 Prerequisites

✅ Flutter SDK 3.3.0 or higher
✅ Dart SDK 3.0.0 or higher
✅ Android Studio / VS Code with Flutter extensions
✅ Firebase account (free tier works)
✅ Gemini API key (Get free key)
✅ Git installed

🚀 Quick Start

# 1️⃣ Clone the repository
git clone https://github.com/Lord-shaban/Nota.git
cd nota

# 2️⃣ Install dependencies
flutter pub get

# 3️⃣ Run the app
flutter run

⚙️ Full Setup Guide

Step 1: Firebase Configuration

Create a project at Firebase Console
Enable these services:
- ✅ Authentication (Email, Google, Facebook, GitHub, Apple)
- ✅ Cloud Firestore
- ✅ Firebase Storage

Download configuration files:

android/app/google-services.json     # Android
ios/Runner/GoogleService-Info.plist  # iOS

Step 2: Gemini AI Setup

Get API key from Google AI Studio
Create .env file in root directory:
```
GEMINI_API_KEY=your_api_key_here
```

Step 3: Social Auth Setup

See 📄 SOCIAL_AUTH_SETUP.md for detailed instructions:

Provider	Setup Link
🔵 Google	Google Cloud Console
📘 Facebook	Facebook Developers
🐙 GitHub	GitHub OAuth Apps
🍎 Apple	Apple Developer

Step 4: Run on Different Platforms

# 📱 Android
flutter run -d android

# 🍎 iOS
flutter run -d ios

# 🌐 Web
flutter run -d chrome

# 🖥️ Desktop (Windows/macOS/Linux)
flutter run -d windows
flutter run -d macos
flutter run -d linux

# 🚀 Release Build
flutter build apk --release        # Android APK
flutter build appbundle --release  # Android App Bundle
flutter build ios --release        # iOS
flutter build web --release        # Web

📁 Project Structure

nota/
│
├── 📱 lib/                           # Main source code
│   ├── main.dart                     # App entry point
│   ├── firebase_options.dart         # Firebase configuration
│   │
│   ├── 🎨 core/                      # Core utilities
│   │   ├── models/                   # Data models (UserModel, NoteModel, etc.)
│   │   ├── theme/                    # App theme & colors
│   │   └── utils/                    # Helper functions
│   │
│   └── ⚡ features/                   # Feature modules
│       │
│       ├── 🔐 auth/                  # Authentication
│       │   ├── login/                # Enhanced login screen
│       │   ├── register/             # Registration with password strength
│       │   ├── splash/               # Animated splash screen
│       │   ├── services/             # AuthService, SocialAuthService
│       │   └── widgets/              # Reusable auth widgets
│       │
│       ├── 🏠 dashboard/             # Home dashboard
│       │   ├── home_screen.dart      # Main dashboard
│       │   └── widgets/              # Dashboard widgets
│       │
│       ├── 📝 notes/                 # Notes feature
│       │   ├── screens/              # Note list & detail screens
│       │   └── widgets/              # Note cards & forms
│       │
│       ├── ✅ tasks/                  # Tasks feature
│       │   ├── screens/              # Task management screens
│       │   └── widgets/              # Task widgets
│       │
│       └── 🤖 ai/                    # AI integration
│           ├── ai_input_screen.dart  # Smart AI input
│           └── services/             # Gemini AI service
│
├── 🤖 android/                       # Android platform
├── 🍎 ios/                           # iOS platform
├── 🌐 web/                           # Web platform
├── 🖥️ windows/                       # Windows desktop
├── 🖥️ macos/                         # macOS desktop
├── 🐧 linux/                         # Linux desktop
│
├── 🧪 test/                          # Tests
│   ├── unit/                         # Unit tests
│   ├── widget/                       # Widget tests
│   └── integration/                  # Integration tests
│
├── 📚 docs/                          # Documentation
│   ├── AUTH_SYSTEM_README.md
│   ├── SOCIAL_AUTH_SETUP.md
│   └── TASKS_FEATURE.md
│
└── 📄 Configuration Files
    ├── pubspec.yaml                  # Dependencies
    ├── analysis_options.yaml         # Lint rules
    └── firebase.json                 # Firebase config

🧪 Testing

Test Type	Command	Description
🔬 Unit	`flutter test test/unit/`	Test business logic
🧩 Widget	`flutter test test/widget/`	Test UI components
🔗 Integration	`flutter test integration_test/`	Test full flows
📊 Coverage	`flutter test --coverage`	Generate coverage report

# Run all tests
flutter test

# Run with verbose output
flutter test --reporter expanded

# Run specific test file
flutter test test/unit/auth_service_test.dart

# Generate coverage report
flutter test --coverage
genhtml coverage/lcov.info -o coverage/html
open coverage/html/index.html

🤝 Contributing

We love contributions! Here's how to get started:

┌────────────────────────────────────────────────────────────┐
│                     CONTRIBUTION FLOW                       │
├────────────────────────────────────────────────────────────┤
│                                                            │
│   1️⃣ Fork  →  2️⃣ Clone  →  3️⃣ Branch  →  4️⃣ Code  →  5️⃣ PR   │
│                                                            │
└────────────────────────────────────────────────────────────┘

📝 Step by Step

📖 Read CONTRIBUTING.md
🍴 Fork the repository
🌿 Create feature branch:
```
git checkout -b feature/amazing-feature
```

💾 Make changes and commit:

git commit -m 'feat: add amazing feature'

📤 Push to your fork:
```
git push origin feature/amazing-feature
```
🔃 Open a Pull Request

📋 Commit Convention

We follow Conventional Commits:

Emoji	Type	Description
✨	`feat:`	New feature
🐛	`fix:`	Bug fix
📚	`docs:`	Documentation
💄	`style:`	UI/styling changes
♻️	`refactor:`	Code refactoring
🧪	`test:`	Adding tests
🔧	`chore:`	Maintenance
⚡	`perf:`	Performance improvement

👥 Team

Lord-shaban
_{🎯 Project Lead}

GoldenBoy13420
_{💻 Developer}

Ali-0110
_{💻 Developer}

abdelrahman hesham
_{💻 Developer}

📄 Documentation

📚 Document	📝 Description
🔐 AUTH_SYSTEM_README	Complete authentication system documentation
🌐 SOCIAL_AUTH_SETUP	Setup guide for Google, Facebook, GitHub, Apple
✅ TASKS_FEATURE	Tasks & to-dos feature documentation
📅 ENHANCED_TASKS_SUMMARY	Enhanced tasks with subtasks & priorities
🤖 AI_TESTING	AI testing guidelines & examples
🤝 CONTRIBUTING	Contribution guidelines
🔒 SECURITY	Security policies & vulnerability reporting
📜 CODE_OF_CONDUCT	Community code of conduct

🔒 Security

Your security is our priority. Please read SECURITY.md for:

🚨 Reporting vulnerabilities
🔐 Security best practices
🛡️ Data protection policies
🔑 Authentication security measures

🗺️ Roadmap

Phase	Feature	Status
✅	Core authentication system	Done
✅	Social login (Google, Facebook, GitHub, Apple)	Done
✅	Biometric authentication	Done
✅	AI-powered note categorization	Done
✅	Voice input & transcription	Done
✅	Camera & image input	Done
✅	Enhanced UI with animations	Done
🔄	Offline mode with sync	In Progress
📋	Widgets for home screen	Planned
📋	Apple Watch / Wear OS support	Planned
📋	Desktop native features	Planned
📋	AI-powered suggestions	Planned

📋 Project Board

Track our progress and upcoming features:

📜 License

This project is licensed under the MIT License

MIT License

Copyright (c) 2024-2026 Nota Team

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

⭐ Support

If you find Nota helpful, please give it a star!

It helps us grow and motivates the team to keep improving.

Made with ❤️ by the Nota Team

Transform your thoughts. Organize your life.

Name		Name	Last commit message	Last commit date
.github		.github
.vscode		.vscode
android		android
coverage		coverage
docs		docs
ios		ios
lib		lib
linux		linux
macos		macos
test		test
web		web
windows		windows
.gitignore		.gitignore
.gitmessage		.gitmessage
.metadata		.metadata
AI_TESTING.md		AI_TESTING.md
APP_ICON_SETUP.md		APP_ICON_SETUP.md
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
PULL_REQUEST.md		PULL_REQUEST.md
README.md		README.md
SECURITY.md		SECURITY.md
analysis_options.yaml		analysis_options.yaml
devtools_options.yaml		devtools_options.yaml
firebase.json		firebase.json
pubspec.lock		pubspec.lock
pubspec.yaml		pubspec.yaml

Latest commit

History

Folders and files

Repository files navigation