rocketnotes  by fynnfluegge

Markdown note-taking app with LLM-powered features

created 3 years ago
1,241 stars

Top 32.4% on sourcepulse

GitHubView on GitHub
1 Expert Loves This Project
Project Summary

Rocketnotes is a web-based Markdown editor designed for personal knowledge management, offering AI-powered features like text completion, chat, and semantic search. It targets users who want to leverage Large Language Models (LLMs) with their notes, providing flexibility for 100% local or cloud-based operation.

How It Works

The application employs a serverless Retrieval-Augmented Generation (RAG) pipeline, integrating tools like Langchain, Sentence Transformers, FAISS, Ollama, OpenAI, Anthropic, and Voyage. This architecture allows for efficient semantic search and LLM-powered interactions with user notes, supporting both cloud-based LLM providers and local models via Ollama for enhanced privacy and control.

Quick Start & Requirements

  • Install/Run: Sign up for browser access or use Docker for local execution.
  • Prerequisites: Docker is recommended for local RAG with Ollama/Sentence Transformers. Cloud mode requires API keys for services like OpenAI.
  • Setup: Local setup via Docker is straightforward. A Gitpod workspace is available for immediate development.
  • Docs: Contributing Guide

Highlighted Details

  • 100% local RAG option using Ollama and Sentence Transformers.
  • Zettelkasten method support with semantic archiving and vector indexing.
  • Features include code syntax highlighting, Katex/Mermaid support, hierarchical document trees, and document sharing.
  • Neovim plugin (rocketnotes.nvim) integration available.

Maintenance & Community

  • Active development indicated by CI/CD badges for build, deploy, Docker, and Electron builds.
  • Community contributions are encouraged via "good first issues."
  • A Gitpod workspace is provided for easy local development setup.

Licensing & Compatibility

  • License: MIT License.
  • Compatibility: Permissive MIT license allows for commercial use and integration with closed-source projects.

Limitations & Caveats

The project is actively developed, and while it offers local RAG, the setup for advanced local configurations might require familiarity with Docker and LLM tooling. Specific performance benchmarks for local RAG are not detailed in the README.

Health Check
Last commit

1 week ago

Responsiveness

1 day

Pull Requests (30d)
9
Issues (30d)
0
Star History
60 stars in the last 90 days

Explore Similar Projects

Starred by Andrej Karpathy Andrej Karpathy(Founder of Eureka Labs; Formerly at Tesla, OpenAI; Author of CS 231n), Alex Cheema Alex Cheema(Cofounder of EXO Labs), and
3 more.

Perplexica by ItzCrazyKns

0.3%
23k
AI-powered search engine alternative
created 1 year ago
updated 1 day ago
Feedback? Help us improve.