Skip to content

VaradChaudhari0210/Notey

Repository files navigation

📝 Smart Notes Application

A modern, feature-rich notes application built with React and powered by AI. Create, organize, and enhance your notes with intelligent features like summarization, translation, grammar checking, and more.

React Tailwind CSS Groq AI Vite

✨ Features

📝 Core Note Management

  • Rich Text Editor with formatting tools (bold, italic, underline, alignment)
  • Font Size Control with real-time adjustment
  • Copy, Cut, Paste functionality with keyboard shortcuts
  • Auto-save with local storage persistence
  • Note Search with real-time filtering
  • Pin/Unpin Notes for quick access
  • Note Deletion with confirmation

🔐 Security & Privacy

  • End-to-End Encryption for sensitive notes
  • Password Protection with secure encryption
  • Session-based Decryption (re-encrypts when switching notes)
  • Secure Note Storage with local encryption

🤖 AI-Powered Features

  • Smart Summarization - Generate concise summaries of your notes
  • Intelligent Tag Suggestions - Auto-generate relevant tags
  • Glossary Term Extraction - Identify and define technical terms
  • Grammar & Style Checking - Improve your writing quality
  • Multi-Language Translation - Translate notes to 20+ languages

📱 Responsive Design

  • Mobile-First Design - Optimized for all screen sizes
  • Touch-Friendly Interface - Perfect for tablets and phones
  • Collapsible Sidebar - Space-efficient navigation
  • Adaptive Layout - Seamless experience across devices

🎨 Modern UI/UX

  • Clean, Minimalist Design - Focus on content
  • Dark/Light Theme Support - Comfortable viewing
  • Smooth Animations - Polished interactions
  • Accessibility Features - ARIA labels and keyboard navigation

🚀 Quick Start

Prerequisites

  • Node.js 16+
  • npm or yarn
  • Groq API key (for AI features)

Installation

  1. Clone the repository

    git clone <repository-url>
    cd smart-notes-app
  2. Install dependencies

    npm install
  3. Set up environment variables

    # Create .env file
    echo "VITE_GROQ_API_KEY=your_groq_api_key_here" > .env
  4. Start the development server

    npm run dev
  5. Open your browser Navigate to http://localhost:5173

🔧 Configuration

Environment Variables

Create a .env file in your project root:

# Groq AI API Key (required for AI features)
VITE_GROQ_API_KEY=gsk_your_actual_api_key_here

🛠️ Technology Stack

Frontend

  • React 18.3.1 - Modern UI library
  • Vite - Fast build tool and dev server
  • Tailwind CSS - Utility-first CSS framework
  • Lucide React - Beautiful icon library

AI & Services

  • Groq SDK - Fast AI inference platform
  • Llama 3.1 8B Instant - Efficient AI model
  • Crypto-JS - Client-side encryption

Development Tools

  • ESLint - Code linting
  • PostCSS - CSS processing
  • Autoprefixer - CSS vendor prefixing

📁 Project Structure

src/
├── components/          # React components
│   ├── AIFeatures.jsx   # AI-powered features panel
│   ├── EncryptionModal.jsx # Encryption/decryption modal
│   ├── NotesList.jsx    # Notes list component
│   ├── RichTextEditor.jsx # Rich text editor
│   └── SearchBar.jsx    # Search functionality
├── utils/               # Utility functions
│   ├── aiService.js     # Groq AI service integration
│   └── storage.js       # Local storage management
├── App.jsx             # Main application component
├── index.css           # Global styles and Tailwind
└── main.jsx           # Application entry point

🎯 Available Scripts

# Development
npm run dev        

# Production
npm run build      
npm run preview     

# Code Quality
npm run lint        

🌍 Supported Languages (Translation)

  • 🇺🇸 English
  • 🇪🇸 Spanish
  • 🇫🇷 French
  • 🇩🇪 German
  • 🇮🇹 Italian
  • 🇵🇹 Portuguese
  • 🇷🇺 Russian
  • 🇯🇵 Japanese
  • 🇰🇷 Korean
  • 🇨🇳 Chinese
  • 🇸🇦 Arabic
  • 🇮🇳 Hindi
  • 🇳🇱 Dutch
  • 🇸🇪 Swedish
  • 🇳🇴 Norwegian
  • 🇩🇰 Danish
  • 🇫🇮 Finnish
  • 🇵🇱 Polish
  • 🇹🇷 Turkish
  • 🇹🇭 Thai
  • 🇻🇳 Vietnamese

🔒 Security Features

  • Client-Side Encryption: Notes encrypted before storage
  • Password Protection: Individual note passwords
  • Session Security: Auto-re-encryption on note switch
  • No Server Dependency: All data stays on your device

🚀 Performance

  • Fast AI Processing: Groq's optimized inference
  • Efficient Storage: Local storage with compression
  • Responsive UI: Smooth 60fps animations
  • Lazy Loading: Components loaded on demand

📝 License

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

Releases

No releases published

Packages

No packages published