Skip to content
/ unRead Public

A simple chat system that prioritizes user curated context.

Notifications You must be signed in to change notification settings

Van-Ma/unRead

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 

Repository files navigation

unRead

A hybrid Electron + React desktop application where users select and organize their own context for AI-assisted chat. It allows users to highlight text from files, organize it into context folders, and chat with an AI model that answers based solely on the selected context.


Features

  • Multi-tab interface: File Manager and Chat
  • Highlight text in files and save snippets as context
  • Organize snippets into named folders
  • Chat with AI using only selected context
  • Add, edit, and delete context folders
  • Supports .txt and .docx files (basic support for .doc)
  • Electron desktop application
  • View chat log

Preview Images

upload, highlight text, and create context groups

upload, highlight text, and create context groups

chat with user selected context

chat with user selected context

view chat log


Install Dependencies

Prerequisites:

  • Node.js >= 20
  • npm or yarn
  • Python >= 3.10 (for backend API)
  • api token from HuggingFace
npm install
pip install flask flask-cors python-dotenv huggingface-hub

Run Development Server:

  1. Start backend:
python app.py
  1. Start Vite server:
npm run dev
  1. Start Electron app: (must be running at the same time as vite server)
npm run electron

Usage

File Manager Tab

  • Add .txt or .docx files
  • Highlight text to create context snippets
  • Save snippets into named context folders
  • Edit or delete folders

Chat Tab

  • Select a context folder
  • Ask questions based only on the selected context
  • Start a new chat session anytime

Technologies

  • React
  • Vite
  • Electron
  • SCSS
  • Python
  • Flask
  • HuggingFace Inference API

About

A simple chat system that prioritizes user curated context.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •