Skip to content

Latest commit

 

History

3 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 

Repository files navigation

NoteX

NoteX is a full-stack web application designed to help users process audio notes intelligently. It allows users to upload audio files, transcribe them using the Google Gemini API, generate detailed summaries, and visualize the core concepts as a hierarchical mind map. Additionally, it features an AI chat for interacting with your notes.

Features

  • Audio Uploads: Support for various audio formats (mp3, wav, m4a, ogg, webm, flac, aac) up to 50MB.
  • AI Transcription: Automatically extract text from uploaded audio using Google Gemini.
  • Smart Summarization: Generate structured, well-organized summaries of your audio transcriptions.
  • Mind Map Visualization: Automatically convert summaries into interactive visual mind maps using React Flow.
  • AI Chat Assistant: Interact with the AI to ask questions or get further insights.
  • Note Management: Save, view, and delete your audio notes and chat histories.

Tech Stack

Frontend (Client)

  • Framework: React with Vite
  • Visualization: React Flow (for mind maps)
  • Styling: Vanilla CSS

Backend (Server)

  • Framework: Node.js & Express
  • Database: MongoDB (via Mongoose)
  • AI Integration: @google/genai (Google Gemini 2.5 Flash)
  • File Processing: Multer (for handling audio uploads)

Prerequisites

  • Node.js (v18 or higher recommended)
  • A MongoDB Database (Local instance or MongoDB Atlas)
  • A Google Gemini API Key

Setup & Installation

1. Clone the repository

git clone <repository-url>
cd NoteX

2. Backend Setup

Navigate to the server directory to configure the backend.

cd server
npm install

Create a .env file in the server directory and add your configuration details:

MONGO_URI=your_mongodb_connection_string
GEMINI_API_KEY=your_gemini_api_key

Start the backend server:

node server.js
# The server will run on http://localhost:5000

3. Frontend Setup

Open a new terminal and navigate to the client directory.

cd client
npm install

Start the frontend development server:

npm run dev
# The client will run on http://localhost:5173

Usage

  1. Open the frontend application URL in your web browser.
  2. Upload an audio file to create a new "Audio Note".
  3. Wait for the application to process the file: the Gemini AI will transcribe the audio, generate a summary, and construct a mind map.
  4. Review the transcription and summary, and interact with the visual mind map.
  5. Use the chat interface to converse with the AI assistant.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages