Skip to content

Commit

Permalink
remove all things related to flashcards
Browse files Browse the repository at this point in the history
  • Loading branch information
samlhuillier committed Nov 2, 2024
1 parent f3622eb commit 6e99ad0
Show file tree
Hide file tree
Showing 15 changed files with 34 additions and 672 deletions.
43 changes: 25 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,67 +14,74 @@ Private & local AI personal knowledge management app.</h4>
</p>

> ### 📢 Announcement
>
> We are now on [Discord](https://discord.gg/b7zanGCTUY)! Our team is shipping very quickly right now so sharing ❤️feedback❤️ with us will really help shape the product 🚀


## About
**Reor** is an AI-powered desktop note-taking app: it automatically links related notes, answers questions on your notes, provides semantic search and can generate AI flashcards. Everything is stored locally and you can edit your notes with an Obsidian-like markdown editor.

The hypothesis of the project is that AI tools for thought should run models locally *by default*. Reor stands on the shoulders of the giants [Ollama](https://github.com/ollama/ollama), [Transformers.js](https://github.com/xenova/transformers.js) & [LanceDB](https://github.com/lancedb/lancedb) to enable both LLMs and embedding models to run locally:

1. Every note you write is chunked and embedded into an internal vector database.
2. Related notes are connected automatically via vector similarity.
3. LLM-powered Q&A does RAG on your corpus of notes.
4. Everything can be searched semantically.

**Reor** is an AI-powered desktop note-taking app: it automatically links related notes, answers questions on your notes and provides semantic search. Everything is stored locally and you can edit your notes with an Obsidian-like markdown editor.

The hypothesis of the project is that AI tools for thought should run models locally *by default*. Reor stands on the shoulders of the giants [Ollama](https://github.com/ollama/ollama), [Transformers.js](https://github.com/xenova/transformers.js) & [LanceDB](https://github.com/lancedb/lancedb) to enable both LLMs and embedding models to run locally:

1. Every note you write is chunked and embedded into an internal vector database.
2. Related notes are connected automatically via vector similarity.
3. LLM-powered Q&A does RAG on your corpus of notes.
4. Everything can be searched semantically.

https://github.com/reorproject/reor/assets/17236551/94a1dfeb-3361-45cd-8ebc-5cfed81ed9cb
<https://github.com/reorproject/reor/assets/17236551/94a1dfeb-3361-45cd-8ebc-5cfed81ed9cb>

One way to think about Reor is as a RAG app with two generators: the LLM and the human. In Q&A mode, the LLM is fed retrieved context from the corpus to help answer a query. Similarly, in editor mode, the human can toggle the sidebar to reveal related notes "retrieved" from the corpus. This is quite a powerful way of "augmenting" your thoughts by cross-referencing ideas in a current note against related ideas from your corpus.


### Getting Started

1. Download from [reorproject.org](https://reorproject.org) or [releases](https://github.com/reorproject/reor/releases). Mac, Linux & Windows are all supported.
2. Install like a normal App.


### Running local models

Reor interacts directly with Ollama which means you can download and run models locally right from inside Reor. Head to Settings->Add New Local LLM then enter the name of the model you want Reor to download. You can find available models [here](https://ollama.com/library).

You can also [connect to an OpenAI-compatible API](https://www.reorproject.org/docs/documentation/openai-like-api) like Oobabooga, Ollama or OpenAI itself!

### Importing notes 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. Note that if you have frontmatter in your markdown files it may not parse correctly. Integrations with other apps are hopefully coming soon!


### Building from source

Make sure you have [nodejs](https://nodejs.org/en/download) installed.
#### Clone repo:

#### Clone repo

```
git clone https://github.com/reorproject/reor.git
```
#### Install dependencies:

#### Install dependencies

```
npm install
```
#### Run for dev:

#### Run for dev

```
npm run dev
```
#### Build:

#### Build

```
npm run build
```

### Interested in contributing?

We are always on the lookout for contributors keen on building the future of knowledge management. Have a feature idea? Want to squash a bug? Want to improve some styling? We'd love to hear it. Check out our issues page and the [contributing guide](https://www.reorproject.org/docs/documentation/contributing) to get started.

## License

AGPL-3.0 license. See `LICENSE` for details.

*Reor means "to think" in Latin.*
22 changes: 1 addition & 21 deletions src/components/Common/CommonModals.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,12 @@ import React from 'react'

import { useModalOpeners } from '@/contexts/ModalContext'
import SettingsModal from '../Settings/Settings'
import FlashcardMenuModal from '../Flashcard/FlashcardMenuModal'
import { useFileContext } from '@/contexts/FileContext'
import RenameNoteModal from '../File/RenameNote'
import RenameDirModal from '../File/RenameDirectory'

const CommonModals: React.FC = () => {
const {
isSettingsModalOpen,
setIsSettingsModalOpen,
isFlashcardModeOpen,
setIsFlashcardModeOpen,
initialFileToCreateFlashcard,
setInitialFileToCreateFlashcard,
initialFileToReviewFlashcard,
setInitialFileToReviewFlashcard,
} = useModalOpeners()
const { isSettingsModalOpen, setIsSettingsModalOpen } = useModalOpeners()

const { noteToBeRenamed, fileDirToBeRenamed } = useFileContext()

Expand All @@ -26,16 +16,6 @@ const CommonModals: React.FC = () => {
{noteToBeRenamed && <RenameNoteModal />}
{fileDirToBeRenamed && <RenameDirModal />}
<SettingsModal isOpen={isSettingsModalOpen} onClose={() => setIsSettingsModalOpen(false)} />
<FlashcardMenuModal
isOpen={isFlashcardModeOpen}
onClose={() => {
setIsFlashcardModeOpen(false)
setInitialFileToCreateFlashcard('')
setInitialFileToReviewFlashcard('')
}}
initialFileToCreateFlashcard={initialFileToCreateFlashcard}
initialFileToReviewFlashcard={initialFileToReviewFlashcard}
/>
</div>
)
}
Expand Down
174 changes: 0 additions & 174 deletions src/components/Flashcard/FlashcardCreateModal.tsx

This file was deleted.

Loading

0 comments on commit 6e99ad0

Please sign in to comment.