Skip to content
BranchesTags

Repository files navigation

NotesApp

NotesApp is a modern, mobile-responsive web application designed for students and educators to efficiently upload, manage, preview, and download academic notes. The app provides a structured system for storing files with detailed metadata, enabling fast and convenient search and retrieval of notes across devices. Integrated AI assistance, powered by Groq API, offers users real-time support, project information, and step-by-step guidance directly within the application.

Table of Contents

Features

  • Structured Note Metadata:
    Each note contains:

    • Title: Name of the note
    • Description: Brief overview of the content
    • Category: Textbook, Notes, Previous Question Paper
    • Year: 1st, 2nd, 3rd
    • Branch: Computer Science, Electronics & Communication, Mechanical, Civil, Electrical
    • Semester: 1 to 6
    • Subject: Name of the subject
    • File: Main document containing the notes

  • File Preview & Download:
    Users can preview files directly within the app and download them for offline access.

  • User Dashboard & Profile:
    View personal details (username, email) and manage notes from a unified dashboard.

  • Search & Filter:
    Easily search and filter notes by title, branch, year, category, semester, or subject.

  • AI-Powered Chatbot: Integrated intelligent assistant powered by Groq API that helps users:

    Get information about the NotesApp project Receive step-by-step instructions for using features List and explore all available files in the project Answer queries about notes, uploads, and navigation

  • Admin Features:

    • View all registered users
    • Delete uploaded files when necessary

  • Secure File Management:
    Metadata and file contents are stored in separate databases for optimized access and security.

  • Responsive Design:
    Seamless experience across desktops, tablets, and mobile devices.

High-Level Design (HLD)

Components

Frontend (Browser / Mobile)

  • HTML & CSS templates for Dashboard, Upload, Profile, File Preview
  • Sends HTTP requests to Flask backend (RESTful endpoints)
  • Fully mobile-responsive for seamless usage

Backend (Flask Application)

  • Handles routes, requests, and business logic
  • Manages authentication & authorization
  • Middleware for access control (user/admin)
  • Implements all admin and user functionality
  • Interfaces with databases for all operations

Databases

  • SQLite: Stores user info and note metadata for fast lookups
  • MySQL: Stores actual file contents (binary data)

File Management

  • Separation of metadata (SQLite) and file contents (MySQL) ensures speed and security

Admin

  • View users, manage files, delete unwanted uploads

Users

  • Register, login, upload notes, preview/download files

Flow

User → Frontend → Backend → Database → Backend → Frontend → User

Low-Level Design (LLD)

Login/Register Flow

  1. User submits credentials via frontend form
  2. Flask backend validates credentials with SQLite
  3. On success, a session is created
  4. User dashboard is displayed

Upload Notes Flow

  1. User uploads file and enters metadata
  2. Metadata is stored in SQLite
  3. File binary is stored in MySQL
  4. NotesApp update with the new entry

File Preview/Download Flow

  1. User requests a file
  2. Flask retrieves metadata from SQLite to locate file reference
  3. File is fetched from MySQL
  4. Sent to frontend for preview or download

Admin Flow

  1. Admin logs in and is redirected to the admin page
  2. Admin can view all users and uploaded files
  3. Admin can delete files (removes metadata from SQLite and file from MySQL)

User Functionality

  • Sign Up & Login:
    Create an account and securely log in.

  • Upload Notes:
    Authenticated users can upload notes with comprehensive metadata.

  • Preview & Download:
    Instantly preview uploaded files or download as needed.

  • Dashboard:
    Textbooks, Notes and Previous QPs.

  • Profile:
    Access your personal account details and activity.

Authentication & Authorization

  • Only authenticated users can upload, preview, or download notes.
  • Admins have privileged access to manage users and files.
  • Middleware ensures restricted access to protected pages.
  • Public pages include Login, Register, Admin Login, and a limited Dashboard view.

AI Chatbot

Overview

The NotesApp integrates an intelligent AI-powered chatbot built with Groq API, providing users with instant assistance and project information directly from the application.

Features

The AI Chatbot helps users by:

  • Project Information: Get detailed information about the NotesApp project, its features, and capabilities
  • Usage Instructions: Receive step-by-step instructions on how to use various features of the application
  • File Listing: List and explore all available files within the project structure
  • Navigation Help: Get guidance on navigating through different sections of the app
  • Query Answering: Answer user questions about notes, uploads, downloads, and general app functionality

Technology

  • AI Model: Groq API (High-performance language model)
  • Integration: Seamlessly integrated into the user dashboard
  • Availability: Available to all authenticated users
  • Real-time Responses: Instant answers powered by advanced AI capabilities

How It Works

  1. User opens the chatbot interface from the dashboard
  2. User types a query or question
  3. Query is sent to the Groq API backend service
  4. AI processes the request and generates contextual responses
  5. Response is displayed to the user in real-time

Example Queries

  • "What is NotesApp?"
  • "How do I upload a file?"
  • "List all files in the project"
  • "How can I download notes?"
  • "What are the features of this app?"
  • "Show me the project structure"

Database Design

SQLite (User Info & Metadata)

Flowchart

flowchart TD
    A["SQLite Database"] --> B["users Table"]
    A --> C["files_metadata Table"]

    %% Users Table
    subgraph B["users"]
        B1["id: INTEGER PK AUTOINCREMENT"]
        B2["name: TEXT"]
        B3["username: TEXT UNIQUE"]
        B4["email: TEXT"]
        B5["password: TEXT"]
        B6["is_admin: BOOLEAN DEFAULT 0"]
        B7["created_at: TIMESTAMP DEFAULT CURRENT_TIMESTAMP"]
    end

    %% Files_Metadata Table
    subgraph C["files_metadata"]
        C1["id: INTEGER PK AUTOINCREMENT"]
        C2["title: TEXT NOT NULL"]
        C3["description: TEXT"]
        C4["category: TEXT NOT NULL"]
        C5["year: INTEGER NOT NULL"]
        C6["branch: TEXT NOT NULL"]
        C7["sem: INTEGER NOT NULL"]
        C8["subject: TEXT NOT NULL"]
        C9["filename: TEXT NOT NULL"]
        C10["file_id: TEXT"]
        C11["uploaded_by: TEXT NOT NULL"]
        C12["uploaded_at: TIMESTAMP DEFAULT CURRENT_TIMESTAMP"]
    end

    %% Relationship
    B3 -- "username" --> C11
Loading
Table Columns Purpose
Users id, username, email, password_hash, role Stores user credentials and roles
Files_Metadata id, title, description, category, year, branch, semester, subject, file_reference Stores note metadata for fast lookups

MySQL (File Storage)

Flowchart

flowchart TD
    A["MySQL Database"] --> F["files Table"]

    %% Files Table columns
    F --> F1["id: INT NOT NULL AUTO_INCREMENT PRIMARY KEY"]
    F --> F2["filename: VARCHAR(255) NOT NULL"]
    F --> F3["filedata: LONGBLOB NOT NULL"]
    F --> F4["uploaded_at: TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP"]
Loading
Table Columns Purpose
Files file_id, file_data Stores actual file contents, referenced by metadata

Technology Stack

  • Frontend: HTML, CSS, Jinja
  • Backend: Flask (Python)
  • Databases: SQLite (user info & metadata), MySQL (file storage)

NotesApp Architecture Overview

flowchart TD
 subgraph FlaskApp["Flask Application"]
        A["app.py<br>Routing &amp; Middleware"]
        B["auth.py<br>Authentication &amp; Sessions"]
        C["files.py<br>Upload / Preview / Download"]
        D["search.py<br>Search &amp; Filter Notes"]
        E["admin.py<br>Admin Dashboard"]
 end

 subgraph SQLiteDB["SQLite Database"]
        U["Users Table<br>(username, email, password)"]
        FM["Files_Metadata Table<br>(title, description, category, year, branch, semester, subject, file_ref)"]
 end

 subgraph MySQLDB["MySQL Database"]
        FD["Files Table<br>(file_id, file_data)"]
 end

 Client["Client (Browser/Mobile)<br>HTML / CSS"] -- HTTP Requests --> FlaskApp
 A --> B & C & D & E
 B --> U
 C --> FM & FD
 D --> FM
 E --> U & FM & FD
 FlaskApp -- SQL Queries --> SQLiteDB & MySQLDB
 Admin["Admin User"] --> E
Loading

Project Structure


NotesApp/
├── app.py                  # Main Flask application & routing
├── auth.py                 # Authentication blueprint (login, register, logout)
├── admin.py                # Admin blueprint for user/file management
├── ai_chatbot.py           # Groq Chatbot with RAG
├── db.py                   # SQLite database connection & helpers
├── mysql_db.py             # MySQL connection for file storage
├── templates/              # HTML templates
│   ├── dashboard.html
│   ├── profile.html
│   ├── upload.html
│   ├── auth_file/
│   │   └── register.html
│   │   └── login.html
│   ├── admin/
│   │   └── admin_dashboard.html
│   │   └── admin_login.html
│   │   └── user_data.html
│   └── pages.html
├── static/                 # Static assets (CSS, images)
│   ├── profile.css
│   ├── preview.css
│   ├── dashboard.css
│   ├── upload.css
│   └── img/
├── README.md               # Project documentation

How to Run

  1. Clone the repository:

    git clone https://github.com/Manju200417/NotesApp
cd NotesApp

  2. Install dependencies:

    pip install flask pymysql

  3. Set up databases:

    • Configure SQLite for users and metadata.
    • Configure MySQL for file storage.

  4. Run the app:

    python app.py

  5. Open your browser:
    Visit http://127.0.0.1:5000

Screenshots

Login Sign In
Dashboard Pages
Upload Preview
Profile View Admin Dashboard
Admin Login Admin Files
Admin User List AI Bot

Future Enhancements

  • Role-based access control for granular permissions
  • Full-text search for faster and more accurate results
  • Cloud storage integrations (AWS S3, Google Drive)
  • Improved UI/UX using frameworks like React or TailwindCSS

Enjoy seamless note management with NotesApp!

About

NotesApp

Resources

Readme
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages