GithubHelp home page GithubHelp logo

benutzereinszweidrei / reor Goto Github PK

View Code? Open in Web Editor NEW

This project forked from reorproject/reor

0.0 0.0 0.0 14.47 MB

A self-organizing note-taking app powered by local AI models.

Home Page: https://reorproject.org

License: GNU General Public License v3.0

JavaScript 0.38% TypeScript 96.90% CSS 1.79% Makefile 0.41% HTML 0.52%

reor's Introduction

Reor Project

A self-organizing note-taking app powered by local AI models.

License GitHub Release Date - Published_At GitHub Repo stars

reor

About

The Reor Project is a local-first AI application for managing personal knowledge and notes. It uses AI to organize, help write, and answer questions about notes. The key difference between something like mem.ai or Reflect Notes is that the AI models can run fully locally and privately.

Hypotheses

  1. AI should be used to both generate and organise unstructured thoughts and ideas.
  2. Those same thoughts and ideas are private. AI models should run locally.
  3. Notes should be embedded into a feature space so that similar notes can be compared

Features

  • Q&A with your notes.
  • Embedding sidebar to automatically connect similar notes.
  • Semantic search.
  • WYSIWYG Markdown editor.
  • Markdown files stored locally.

Getting Started

  1. Download from the Releases tab. Mac & Windows are currently supported with Linux support coming soon.
  2. Install like a normal App.

Extra Linux packages:

Strangely, Linux induces some package issues with regards to Transformers.js (the library we use for embeddings). So you may need to install the following packages: "fuse", "libfuse2", "libvips". On Ubuntu:

sudo apt update
sudo apt install fuse libfuse2 libvips

Technologies

  • LanceDB vector database for ultra low latency, low-memory and local vector store.
  • Transformers.js to run embedding models locally.
  • Llama.cpp to run local LLMs uber efficiently.

Importing from other apps

Reor works within a single directory in the filesystem. You choose the directory on first boot. To import notes/files from another app, you'll need to populate that directory manually with markdown files. Integrations with other apps are hopefully coming soon!

Beta Phase

The Reor Project is in beta. It is very much stable and usable right now. Of course, it won't be as bug-free as something like Obsidian. But I am working as hard as I can to make this as good of an experience as can be! Feedback and support are welcome on our Issues page.

License

GPL-3.0 license. See LICENSE for details.

reor's People

Contributors

samlhuillier avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.