Noteraity

AI-powered knowledge management and note-taking application built with Tauri, React, and Rust

Noteraity is a modern, intelligent note-taking application that combines powerful AI capabilities with an intuitive interface. Built as a cross-platform desktop app, it helps you capture, organize, and connect your ideas through advanced features like semantic search, knowledge graphs, and AI-assisted writing.

Key Features

AI-Powered Intelligence - Chat with your notes, get smart suggestions, and leverage RAG for contextual responses
Rich Text Editor - Full-featured TipTap editor with 50+ slash commands, markdown support, and advanced formatting
Knowledge Graph - Visualize connections between notes with interactive graph views
Semantic Search - Find notes by meaning, not just keywords, using vector embeddings
Task Management - Integrated todo system with AI-powered extraction and prioritization
Multi-Space Workspaces - Organize notes into separate workspaces with isolated databases
Local-First - Your data stays on your machine with offline-capable SQLite storage
Cross-Platform - Native desktop experience on Windows, macOS, and Linux

Core Features

Note Management

Create and Edit Notes

Rich text editing with auto-save
Multiple view modes: Grid, List, and Compact views
Favorites/starring system for quick access
Note statistics: character count, word count, reading time

Note Types

Custom note types with icons and colors
Predefined templates
Visual type badges for easy identification

Folder Organization

Hierarchical folder structure
Pin important folders
AI-powered automatic folder organization
Smart folder suggestions

Archive & Trash

Soft delete to trash with restore capability
Permanent deletion options
Empty trash functionality
Time-grouped trash view
Archive feature for decluttering workspace

Multi-Space Workspaces

Create multiple isolated workspaces (spaces)
Separate databases per space
Custom names, descriptions, icons, and colors
Switch between spaces seamlessly
Independent note collections and tag systems per space

AI Capabilities

AI Chat Assistant

Interactive Conversations

Real-time streaming AI responses
Multi-turn conversation support
Message history and management
Context-aware responses based on your notes

Smart Features

Context-aware suggestions during conversations
Multi-modal message support (text, code, markdown)
Citation display for referenced notes
Chat with specific note context

RAG (Retrieval-Augmented Generation)

Vector Search & Embeddings

Automatic note indexing for semantic search
Vector embeddings for similarity matching
RAG-enabled AI responses with relevant note context
Confidence scores for retrieved information

RAG Management

Index all notes automatically
Track indexing progress and status
Debug RAG responses with citation sources
Failed notes tracking and recovery

AI Model Support

Multiple Providers

OpenAI integration
Anthropic Claude support
Ollama for local models
Easy model switching

Model Management

Configure and download local models
Connection status monitoring
Model availability checking
AI diagnostics and troubleshooting

AI-Powered Features

Auto-tagging with confidence scores
Extract todos from notes automatically
AI-suggested priority levels and due dates
Web search integration for hybrid responses

Editor Features

Rich Text Editing

Noteraity includes a powerful TipTap-based editor with extensive formatting capabilities:

Text Formatting

Bold, Italic, Underline, Strikethrough
Subscript & Superscript
Text alignment (left, center, right, justify)
Text and highlight colors
Multiple font families and sizes

Content Blocks

Headings (H1, H2, H3) with table of contents
Code blocks with syntax highlighting (Shiki)
Tables with horizontal scrolling
Blockquotes
Collapsible details/summary sections
Horizontal rules
Task lists with checkboxes

Lists

Bullet lists
Numbered/ordered lists
Nested list support
Task lists with completion tracking

Media

Image upload and embedding (drag & drop)
Remote image import from URLs
YouTube video embedding
Web embeds with iframe support

Advanced Editor Features

Slash Commands (50+)

Type / to open command palette
Quick formatting commands
Block insertion (headings, quotes, code, tables)
Media embeds (YouTube, web)
URL article extraction
AI commands
Table of contents generation
Command search and filtering

Smart Shortcuts

Markdown syntax shortcuts
Auto-formatting (e.g., *text* → bold)
Quick list creation
Paste markdown with auto-conversion

Linking & Mentions

Link to other notes with [[note-title]] syntax
Mention notes with @ prefix
Tag items with # syntax
Auto-complete suggestions
Note link preview panels

Productivity Features

Drag & drop block reordering
Focus mode for distraction-free writing
Floating and bubble menus for quick formatting
Character and word counting
Auto-save and draft preservation
Placeholder text with dynamic suggestions

Search & Discovery

Full-Text Search

Advanced Search

Real-time search with debouncing
Search result highlighting
Filter by tags, content, and title
Date range filtering
File pattern matching
Search tips and guidance

Search Index

Automatic note indexing
Index caching for performance
Full index rebuild capability
Search statistics and metrics

Semantic Search

Vector-based similarity search
Find notes by meaning, not just keywords
AI-powered context retrieval
Confidence scoring for results

Knowledge Graph

Visual Graph Views

Interactive Visualization

Force-directed graph layout
Two modes: Traditional and Advanced
D3-based and React Force Graph implementations
Interactive node exploration
Click to navigate to connected notes

Graph Controls

Connection strength filtering (confidence threshold 0.7-1.0)
Max nodes control (up to 50 nodes)
View mode switching
Manual refresh
Efficient caching (15-minute TTL)

Note Linking System

Bidirectional Links

Link related notes together
Confidence scores for connections
Link type classification
Automatic backlink support

Link Management

Create and delete links
Link preview functionality
Connection metadata tracking
In-editor link suggestions

Task Management

Todo System

Create and Manage Tasks

Create todos with title and description
Edit and delete todos
Bulk operations support

Todo Properties

Status tracking: Todo, In Progress, Completed, Cancelled
Priority levels: Low, Medium, High, Critical
Due dates and reminders
Tags and categories
Metadata storage
Completion timestamps

Views & Filtering

Grid and list view modes
Filter by status, priority, due date, and tags
Search todos
Overdue todo highlighting
Special views: Overdue and Upcoming todos

AI-Powered Todo Features

Auto-extract todos from note content
AI-suggested priority levels
AI-suggested due dates
Todo chat integration for AI-assisted management

Todo-Note Integration

Link todos to specific notes
View todos associated with a note
Bidirectional linking
/todo slash command in editor

Organization

Tags System

Tag Management

Create custom tags with colors
Edit and delete tags
Tag favorites
Color customization

Tag Features

Tag library with statistics
Note count per tag
Filter notes by tag
Tag consolidation (merge similar tags)
Visual tag cloud
AI-powered auto-tagging with confidence scores

Import & Export

Web Clipping

Extract articles from URLs
Automatic content formatting
Image preservation with proxy
Readability-based parsing
Paste URL in slash commands

Database Import

Import from legacy databases
Create new space from imported data
Automatic space switching

Customization

Appearance

30+ Themes

Light and Dark variants
High contrast themes (accessibility)
Popular themes: Solarized, Dracula, Monokai, Nord, Gruvbox
Catppuccin variants: Latte, Frappe, Macchiato, Mocha
Modern themes: Cyberpunk, Forest, Ocean, Sunset, Midnight, Sakura, Desert, Arctic, Chalkboard

Typography

Multiple font options: Geist, Inter, System, Monospace, Roboto, Open Sans
Customizable font sizes

Settings

Comprehensive Settings

General preferences (auto-save, sync, auto-lock)
Appearance customization (themes, fonts)
Editor preferences and autocomplete
Keyboard shortcuts management
AI configuration (providers, models, RAG settings)
Organization defaults
Database management

User Experience

Dashboard

Quick stats overview (notes count, todo statistics)
Recent notes display
Quick actions (new note, AI assistant, todos)
First-time user walkthrough
AI connection status

Navigation

Collapsible left sidebar with folder tree
Multi-tab editor for multiple open notes
Breadcrumb navigation
Custom title bar (native window controls)
Right panel for contextual information and AI chat

Technology Stack

Frontend

React 19 - Modern UI library with TypeScript
Vite - Fast build tool and dev server
TipTap - Extensible rich text editor
Tailwind CSS - Utility-first styling
Shadcn/UI - Accessible component library
Radix UI - Primitive UI components
D3.js - Data visualization for graphs
React Force Graph - Interactive graph visualization
Zustand - Lightweight state management
React Router - Client-side routing

Backend

Tauri 2.0 - Cross-platform desktop framework
Rust - High-performance backend logic
SQLite - Local database storage
PostgreSQL Support - Optional remote database

AI & ML

OpenAI API - GPT models integration
Anthropic Claude - Advanced AI capabilities
Ollama - Local LLM execution
pgvector - Vector similarity search
Embeddings - Semantic search support

Additional Libraries

Shiki - Syntax highlighting
Lowlight - Code parsing
Marked - Markdown rendering
React Markdown - Markdown components
date-fns - Date manipulation
Recharts - Analytics charts

Getting Started

Prerequisites

Before installing Noteraity, ensure you have:

Node.js (v18 or later) - Download
Rust (latest stable) - Install
Tauri CLI - Install via cargo install tauri-cli

Installation

Clone the repository

git clone https://github.com/okikorg/noteraity.git
cd noteraity

Install dependencies
```
npm install
```

Configure the application

# The setup script will run automatically before dev/build
# Or run it manually:
sh ./setup-config.sh

Run in development mode
```
npm run tauri:dev
```
Build for production
```
npm run tauri:build
```

Configuration

AI Provider Setup

To use AI features, configure your preferred provider in Settings > AI Configuration:

OpenAI: Add your API key
Claude: Configure Anthropic API credentials
Ollama: Install Ollama and pull models locally

Database Setup

Noteraity uses SQLite by default for local storage. No additional database setup is required for basic usage.

Development

Project Structure

.
├── src/                    # Frontend source code
│   ├── components/         # React components
│   │   ├── ai/            # AI chat and features
│   │   ├── editor/        # TipTap editor components
│   │   ├── graph/         # Knowledge graph views
│   │   ├── notes/         # Note management UI
│   │   ├── todos/         # Todo system
│   │   ├── tags/          # Tag management
│   │   ├── settings/      # Settings pages
│   │   └── layout/        # App layout components
│   ├── pages/             # Route pages
│   ├── stores/            # Zustand state management
│   ├── api/               # API integration
│   ├── lib/               # Utilities and helpers
│   ├── hooks/             # Custom React hooks
│   ├── types/             # TypeScript type definitions
│   └── styles/            # Global styles
├── src-tauri/             # Backend source code (Rust)
│   ├── src/
│   │   ├── main.rs        # Main entry point
│   │   ├── commands/      # Tauri commands
│   │   └── database/      # Database logic
│   └── Cargo.toml         # Rust dependencies
├── public/                # Static assets
├── packaging/             # Build scripts and installers
└── ...

Available Scripts

# Development
npm run dev                 # Start Vite dev server
npm run tauri:dev          # Start Tauri dev mode

# Building
npm run build              # Build frontend
npm run build:check        # Type check + build
npm run tauri:build        # Build Tauri app

# Testing
npm run test               # Run tests
npm run test:ui            # Run tests with UI
npm run test:coverage      # Generate coverage report

# Packaging
npm run package            # Create distribution package
npm run package:bundler    # Run bundler script

Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.

Testing

Run the test suite:

npm run test

View test UI:

npm run test:ui

Open Source Edition

This is the Open Source Edition of Noteraity with authentication and billing features removed for a fully local, privacy-focused experience.

Key Differences:

No authentication required - direct access to all features
No billing/subscription system
Fully local operation
All notes stored on your machine
No external API dependencies (except optional AI providers)

Getting Started:

Start at /dashboard (default route)
No sign-in required
All features immediately available

Privacy & Security

Local-First Architecture

All notes stored locally in SQLite databases
No cloud sync (unless explicitly configured)
Your data never leaves your machine by default

Secure Storage

Encrypted credential storage
Secure token management
Protected API keys

AI Privacy

Choose your AI provider
Option for fully local models (Ollama)
Control what data is sent to AI services

Roadmap

Planned Features:

Enhanced mobile companion app
Cloud sync option (optional, end-to-end encrypted)
Advanced plugin system
Collaboration features
More AI model integrations
Enhanced graph analytics
Export to multiple formats (PDF, HTML, Markdown)

Support

For issues, feature requests, or questions:

Create an issue on GitHub
Check existing documentation
Join community discussions

License

[Add your license information here]

Acknowledgments

Built with:

Tauri - Cross-platform framework
React - UI library
TipTap - Rich text editor
Shadcn/UI - Component library
Tailwind CSS - Styling
D3.js - Visualizations

And many other open source projects that make Noteraity possible.

Made with care for knowledge workers, researchers, writers, and anyone who thinks deeply.

Name		Name	Last commit message	Last commit date
Latest commit History 168 Commits
.claude/commands		.claude/commands
.specify		.specify
.taskmaster		.taskmaster
.vscode		.vscode
landing-page		landing-page
migration-plan		migration-plan
packaging		packaging
public		public
scripts		scripts
specs		specs
src-tauri		src-tauri
src		src
.env.example		.env.example
.gitignore		.gitignore
AGENTS.md		AGENTS.md
AI_CHAT_STREAMING_TEST_SCENARIOS.md		AI_CHAT_STREAMING_TEST_SCENARIOS.md
AI_SEARCH_INTEGRATION.md		AI_SEARCH_INTEGRATION.md
AUTH_FLOW.md		AUTH_FLOW.md
BILLING_INTEGRATION.md		BILLING_INTEGRATION.md
CONFIG.md		CONFIG.md
DEPLOYMENT.md		DEPLOYMENT.md
DUPLICATE_RAG_RESPONSE_FIX.md		DUPLICATE_RAG_RESPONSE_FIX.md
DUPLICATE_RESPONSE_FIX.md		DUPLICATE_RESPONSE_FIX.md
FINAL_RAG_FIX.md		FINAL_RAG_FIX.md
HEADLESS_AUTH_IMPLEMENTATION.md		HEADLESS_AUTH_IMPLEMENTATION.md
NEON_AUTH_MIGRATION.md		NEON_AUTH_MIGRATION.md
POLAR_INTEGRATION.md		POLAR_INTEGRATION.md
RAG_FIX_SUMMARY.md		RAG_FIX_SUMMARY.md
RAG_SETUP.md		RAG_SETUP.md
README.md		README.md
README_PACKAGING.md		README_PACKAGING.md
STORAGE_OPTIONS.md		STORAGE_OPTIONS.md
SYNC_IMPROVEMENTS.md		SYNC_IMPROVEMENTS.md
TAG_AUTOCOMPLETE_IMPLEMENTATION.md		TAG_AUTOCOMPLETE_IMPLEMENTATION.md
TAG_REUSE_IMPLEMENTATION.md		TAG_REUSE_IMPLEMENTATION.md
TEST_INSTRUCTIONS.md		TEST_INSTRUCTIONS.md
TEST_RESULTS.md		TEST_RESULTS.md
components.json		components.json
config.json		config.json
container-styles.css		container-styles.css
context_output_large_test_note.txt		context_output_large_test_note.txt
context_output_sample_research_notes.txt		context_output_sample_research_notes.txt
download_ollama.sh		download_ollama.sh
fix_database_columns.sh		fix_database_columns.sh
fix_todos_table.sh		fix_todos_table.sh
index.html		index.html
migrate_database_schema.sh		migrate_database_schema.sh
migrate_databases.sh		migrate_databases.sh
migrate_test_db.js		migrate_test_db.js
package-lock.json		package-lock.json
package.json		package.json
postcss.config.js		postcss.config.js
reindex-all-notes.sh		reindex-all-notes.sh
reindex_notes.js		reindex_notes.js
requirements.txt		requirements.txt
reset_databases.sh		reset_databases.sh
setup-config.sh		setup-config.sh
setup.sh		setup.sh
start-postgres.sh		start-postgres.sh
tailwind.config.js		tailwind.config.js
test-embedding-fix.sh		test-embedding-fix.sh
test-html-cleaning.sh		test-html-cleaning.sh
test-rag-indexing.sh		test-rag-indexing.sh
test-todo-by-note.ts		test-todo-by-note.ts
test_autotag.js		test_autotag.js
test_fast_tagging.js		test_fast_tagging.js
test_rag.js		test_rag.js
test_rag.py		test_rag.py
test_spaces.html		test_spaces.html
test_tag_similarity.js		test_tag_similarity.js
toggle-demo.md		toggle-demo.md
toggle-list-demo.md		toggle-list-demo.md
trigger_full_reindex.html		trigger_full_reindex.html
tsconfig.json		tsconfig.json
tsconfig.node.json		tsconfig.node.json
update_commands.sh		update_commands.sh
verify-rag-fix.sh		verify-rag-fix.sh
vite.config.ts		vite.config.ts

okikorg/Noteraity

Folders and files

Latest commit

History

Repository files navigation