Skip to content

Commit 6e99ad0

Browse files
committed
remove all things related to flashcards
1 parent f3622eb commit 6e99ad0

15 files changed

+34
-672
lines changed

README.md

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -14,67 +14,74 @@ Private & local AI personal knowledge management app.</h4>
1414
</p>
1515

1616
> ### 📢 Announcement
17+
>
1718
> 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 🚀
1819
19-
20-
2120
## About
22-
**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.
23-
24-
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:
25-
26-
1. Every note you write is chunked and embedded into an internal vector database.
27-
2. Related notes are connected automatically via vector similarity.
28-
3. LLM-powered Q&A does RAG on your corpus of notes.
29-
4. Everything can be searched semantically.
3021

22+
**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.
3123

24+
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:
3225

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

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

3633
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.
3734

38-
3935
### Getting Started
36+
4037
1. Download from [reorproject.org](https://reorproject.org) or [releases](https://github.com/reorproject/reor/releases). Mac, Linux & Windows are all supported.
4138
2. Install like a normal App.
4239

43-
4440
### Running local models
41+
4542
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).
4643

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

4946
### Importing notes from other apps
47+
5048
Reor works within a single directory in the filesystem. You choose the directory on first boot.
5149
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!
5250

53-
5451
### Building from source
5552

5653
Make sure you have [nodejs](https://nodejs.org/en/download) installed.
57-
#### Clone repo:
54+
55+
#### Clone repo
56+
5857
```
5958
git clone https://github.com/reorproject/reor.git
6059
```
61-
#### Install dependencies:
60+
61+
#### Install dependencies
62+
6263
```
6364
npm install
6465
```
65-
#### Run for dev:
66+
67+
#### Run for dev
68+
6669
```
6770
npm run dev
6871
```
69-
#### Build:
72+
73+
#### Build
74+
7075
```
7176
npm run build
7277
```
7378

7479
### Interested in contributing?
80+
7581
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.
7682

7783
## License
84+
7885
AGPL-3.0 license. See `LICENSE` for details.
7986

8087
*Reor means "to think" in Latin.*

src/components/Common/CommonModals.tsx

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,12 @@ import React from 'react'
22

33
import { useModalOpeners } from '@/contexts/ModalContext'
44
import SettingsModal from '../Settings/Settings'
5-
import FlashcardMenuModal from '../Flashcard/FlashcardMenuModal'
65
import { useFileContext } from '@/contexts/FileContext'
76
import RenameNoteModal from '../File/RenameNote'
87
import RenameDirModal from '../File/RenameDirectory'
98

109
const CommonModals: React.FC = () => {
11-
const {
12-
isSettingsModalOpen,
13-
setIsSettingsModalOpen,
14-
isFlashcardModeOpen,
15-
setIsFlashcardModeOpen,
16-
initialFileToCreateFlashcard,
17-
setInitialFileToCreateFlashcard,
18-
initialFileToReviewFlashcard,
19-
setInitialFileToReviewFlashcard,
20-
} = useModalOpeners()
10+
const { isSettingsModalOpen, setIsSettingsModalOpen } = useModalOpeners()
2111

2212
const { noteToBeRenamed, fileDirToBeRenamed } = useFileContext()
2313

@@ -26,16 +16,6 @@ const CommonModals: React.FC = () => {
2616
{noteToBeRenamed && <RenameNoteModal />}
2717
{fileDirToBeRenamed && <RenameDirModal />}
2818
<SettingsModal isOpen={isSettingsModalOpen} onClose={() => setIsSettingsModalOpen(false)} />
29-
<FlashcardMenuModal
30-
isOpen={isFlashcardModeOpen}
31-
onClose={() => {
32-
setIsFlashcardModeOpen(false)
33-
setInitialFileToCreateFlashcard('')
34-
setInitialFileToReviewFlashcard('')
35-
}}
36-
initialFileToCreateFlashcard={initialFileToCreateFlashcard}
37-
initialFileToReviewFlashcard={initialFileToReviewFlashcard}
38-
/>
3919
</div>
4020
)
4121
}

src/components/Flashcard/FlashcardCreateModal.tsx

Lines changed: 0 additions & 174 deletions
This file was deleted.

0 commit comments

Comments
 (0)