research-helper
THE reference manager with features including PDF reading/annotating, Markdown/Excalidraw note-taking, project/note linking, and more...
File Explorer
Download Latest Version (.zip)- build.yml
- test-main.yml
- test.yml
- library-page.png
- note-page.png
- reader-page.png
- 78-EUC-H.bcmap
- 78-EUC-V.bcmap
- 78-H.bcmap
- 78-RKSJ-H.bcmap
- 78-RKSJ-V.bcmap
- 78-V.bcmap
- 78ms-RKSJ-H.bcmap
- 78ms-RKSJ-V.bcmap
- 83pv-RKSJ-H.bcmap
- 90ms-RKSJ-H.bcmap
- 90ms-RKSJ-V.bcmap
- 90msp-RKSJ-H.bcmap
- 90msp-RKSJ-V.bcmap
- 90pv-RKSJ-H.bcmap
- 90pv-RKSJ-V.bcmap
- Add-H.bcmap
- Add-RKSJ-H.bcmap
- Add-RKSJ-V.bcmap
- Add-V.bcmap
- Adobe-CNS1-0.bcmap
- Adobe-CNS1-1.bcmap
- Adobe-CNS1-2.bcmap
- Adobe-CNS1-3.bcmap
- Adobe-CNS1-4.bcmap
- Adobe-CNS1-5.bcmap
- Adobe-CNS1-6.bcmap
- Adobe-CNS1-UCS2.bcmap
- Adobe-GB1-0.bcmap
- Adobe-GB1-1.bcmap
- Adobe-GB1-2.bcmap
- Adobe-GB1-3.bcmap
- Adobe-GB1-4.bcmap
- Adobe-GB1-5.bcmap
- Adobe-GB1-UCS2.bcmap
- Adobe-Japan1-0.bcmap
- Adobe-Japan1-1.bcmap
- Adobe-Japan1-2.bcmap
- Adobe-Japan1-3.bcmap
- Adobe-Japan1-4.bcmap
- Adobe-Japan1-5.bcmap
- Adobe-Japan1-6.bcmap
- Adobe-Japan1-UCS2.bcmap
- Adobe-Korea1-0.bcmap
- Adobe-Korea1-1.bcmap
- Adobe-Korea1-2.bcmap
- Adobe-Korea1-UCS2.bcmap
- B5-H.bcmap
- B5-V.bcmap
- B5pc-H.bcmap
- B5pc-V.bcmap
- CNS-EUC-H.bcmap
- CNS-EUC-V.bcmap
- CNS1-H.bcmap
- CNS1-V.bcmap
- CNS2-H.bcmap
- CNS2-V.bcmap
- ETen-B5-H.bcmap
- ETen-B5-V.bcmap
- ETenms-B5-H.bcmap
- ETenms-B5-V.bcmap
- ETHK-B5-H.bcmap
- ETHK-B5-V.bcmap
- EUC-H.bcmap
- EUC-V.bcmap
- Ext-H.bcmap
- Ext-RKSJ-H.bcmap
- Ext-RKSJ-V.bcmap
- Ext-V.bcmap
- GB-EUC-H.bcmap
- GB-EUC-V.bcmap
- GB-H.bcmap
- GB-V.bcmap
- GBK-EUC-H.bcmap
- GBK-EUC-V.bcmap
- GBK2K-H.bcmap
- GBK2K-V.bcmap
- GBKp-EUC-H.bcmap
- GBKp-EUC-V.bcmap
- GBpc-EUC-H.bcmap
- GBpc-EUC-V.bcmap
- GBT-EUC-H.bcmap
- GBT-EUC-V.bcmap
- GBT-H.bcmap
- GBT-V.bcmap
- GBTpc-EUC-H.bcmap
- GBTpc-EUC-V.bcmap
- H.bcmap
- Hankaku.bcmap
- Hiragana.bcmap
- HKdla-B5-H.bcmap
- HKdla-B5-V.bcmap
- HKdlb-B5-H.bcmap
- HKdlb-B5-V.bcmap
- HKgccs-B5-H.bcmap
- HKgccs-B5-V.bcmap
- HKm314-B5-H.bcmap
- HKm314-B5-V.bcmap
- HKm471-B5-H.bcmap
- HKm471-B5-V.bcmap
- HKscs-B5-H.bcmap
- HKscs-B5-V.bcmap
- Katakana.bcmap
- KSC-EUC-H.bcmap
- KSC-EUC-V.bcmap
- KSC-H.bcmap
- KSC-Johab-H.bcmap
- KSC-Johab-V.bcmap
- KSC-V.bcmap
- KSCms-UHC-H.bcmap
- KSCms-UHC-HW-H.bcmap
- KSCms-UHC-HW-V.bcmap
- KSCms-UHC-V.bcmap
- KSCpc-EUC-H.bcmap
- KSCpc-EUC-V.bcmap
- LICENSE
- NWP-H.bcmap
- NWP-V.bcmap
- RKSJ-H.bcmap
- RKSJ-V.bcmap
- Roman.bcmap
- UniCNS-UCS2-H.bcmap
- UniCNS-UCS2-V.bcmap
- UniCNS-UTF16-H.bcmap
- UniCNS-UTF16-V.bcmap
- UniCNS-UTF32-H.bcmap
- UniCNS-UTF32-V.bcmap
- UniCNS-UTF8-H.bcmap
- UniCNS-UTF8-V.bcmap
- UniGB-UCS2-H.bcmap
- UniGB-UCS2-V.bcmap
- UniGB-UTF16-H.bcmap
- UniGB-UTF16-V.bcmap
- UniGB-UTF32-H.bcmap
- UniGB-UTF32-V.bcmap
- UniGB-UTF8-H.bcmap
- UniGB-UTF8-V.bcmap
- UniJIS-UCS2-H.bcmap
- UniJIS-UCS2-HW-H.bcmap
- UniJIS-UCS2-HW-V.bcmap
- UniJIS-UCS2-V.bcmap
- UniJIS-UTF16-H.bcmap
- UniJIS-UTF16-V.bcmap
- UniJIS-UTF32-H.bcmap
- UniJIS-UTF32-V.bcmap
- UniJIS-UTF8-H.bcmap
- UniJIS-UTF8-V.bcmap
- UniJIS2004-UTF16-H.bcmap
- UniJIS2004-UTF16-V.bcmap
- UniJIS2004-UTF32-H.bcmap
- UniJIS2004-UTF32-V.bcmap
- UniJIS2004-UTF8-H.bcmap
- UniJIS2004-UTF8-V.bcmap
- UniJISPro-UCS2-HW-V.bcmap
- UniJISPro-UCS2-V.bcmap
- UniJISPro-UTF8-V.bcmap
- UniJISX0213-UTF32-H.bcmap
- UniJISX0213-UTF32-V.bcmap
- UniJISX02132004-UTF32-H.bcmap
- UniJISX02132004-UTF32-V.bcmap
- UniKS-UCS2-H.bcmap
- UniKS-UCS2-V.bcmap
- UniKS-UTF16-H.bcmap
- UniKS-UTF16-V.bcmap
- UniKS-UTF32-H.bcmap
- UniKS-UTF32-V.bcmap
- UniKS-UTF8-H.bcmap
- UniKS-UTF8-V.bcmap
- V.bcmap
- WP-Symbol.bcmap
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- chrome.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- viewer.properties
- README.md
- annotation-check.svg
- annotation-comment.svg
- annotation-help.svg
- annotation-insert.svg
- annotation-key.svg
- annotation-newparagraph.svg
- annotation-noicon.svg
- annotation-note-transparent.svg
- annotation-note.svg
- annotation-paragraph.svg
- loading-icon.gif
- shadow.png
- help_en_US.md
- help_zh_CN.md
- logo.svg
- index.ts
- index.ts
- models.ts
- sophosiadb.ts
- annotationFactory.ts
- annotations.ts
- annotationStore.ts
- index.ts
- grabToPan.js
- index.ts
- peekManager.ts
- index.ts
- file.ts
- folder.ts
- folder.vitest.test.ts
- graph.ts
- graph.vitest.test.ts
- meta.ts
- meta.vitest.test.ts
- note.ts
- note.vitest.test.ts
- project.ts
- project.vitest.test.ts
- utils.ts
- utils.vitest.test.ts
- .gitkeep
- axios.ts
- bus.ts
- db.ts
- i18n.ts
- plugin.ts
- GraphView.vue
- LeftMenu.vue
- PluginView.vue
- ProjectNavigator.vue
- ProjectTree.vue
- ActionBar.vue
- DeleteDialog.cy.ts
- DeleteDialog.vue
- ExportDialog.cy.ts
- ExportDialog.vue
- FolderTree.vue
- IdentifierDialog.cy.ts
- IdentifierDialog.vue
- ImportDialog.cy.ts
- ImportDialog.vue
- injectKeys.ts
- ProjectBrowser.vue
- ProjectTable.vue
- TableItemRow.cy.ts
- TableItemRow.vue
- TableProjectMenu.vue
- TableProjectRow.vue
- TableSearchRow.cy.ts
- TableSearchRow.vue
- CustomExcalidraw.tsx
- HoverPane.vue
- NoteEditor.vue
- AnnotCard.cy.ts
- AnnotCard.vue
- AnnotList.cy.ts
- AnnotList.vue
- AnnotMenu.cy.ts
- AnnotMenu.vue
- ColorPicker.cy.ts
- ColorPicker.vue
- EraserDropdownBtn.cy.ts
- EraserDropdownBtn.vue
- FloatingMenu.vue
- FloatingMenuView.vue
- injectKeys.ts
- InkDropdownBtn.cy.ts
- InkDropdownBtn.vue
- PDFReader.vue
- PDFTOC.cy.ts
- PDFTOC.vue
- PDFToolBar.cy.ts
- PDFToolBar.vue
- PeekCard.vue
- RightMenu.cy.ts
- RightMenu.vue
- SearchDropdownBtn.cy.ts
- SearchDropdownBtn.vue
- ViewDropdownBtn.cy.ts
- ViewDropdownBtn.vue
- ActionBar.vue
- PluginCard.vue
- PluginList.vue
- PluginStore.vue
- PluginTab.vue
- AboutTab.vue
- GeneralTab.vue
- ProgressDialog.cy.ts
- ProgressDialog.vue
- ErrorDialog.cy.ts
- ErrorDialog.vue
- MetaInfoTab.cy.ts
- MetaInfoTab.vue
- WelcomeCarousel.cy.ts
- WelcomeCarousel.vue
- theme.scss
- close.svg
- lm_close_black.png
- lm_close_tab_white.png
- lm_close_white.png
- lm_maximise_black.png
- lm_maximise_white.png
- lm_minimize_black.png
- lm_minimize_white.png
- lm_popin_black.png
- lm_popin_white.png
- lm_popout_black.png
- lm_popout_white.png
- base.scss
- theme.scss
- dark.css
- index.css
- light.css
- app.scss
- quasar.variables.scss
- en_US.json
- zh_CN.json
- AppLayout.vue
- GLayout.vue
- LeftRibbon.vue
- MainLayout.vue
- ExcalidrawPage.vue
- GLComponent.vue
- HelpPage.vue
- LibraryPage.vue
- NotePage.vue
- PluginPage.vue
- PluginSettingsPage.vue
- ReaderPage.vue
- SettingsPage.vue
- index.ts
- routes.ts
- appState.ts
- index.ts
- projectStore.ts
- store-flag.d.ts
- App.vue
- env.d.ts
- quasar.d.ts
- shims-vue.d.ts
- icon.icns
- icon.ico
- icon.png
- electron-env.d.ts
- electron-flag.d.ts
- electron-main.ts
- electron-preload.ts
- annotDatas.json
- outline.json
- project.json
- commands.ts
- component-index.html
- component.ts
- e2e.ts
- DialogWrapper.vue
- LayoutContainer.vue
- .gitignore
- setup-file.ts
- .editorconfig
- .eslintignore
- .eslintrc.js
- .gitignore
- .npmrc
- .nycrc
- .prettierrc
- cypress.config.ts
- cypress.d.ts
- index.html
- LICENSE
- package.json
- postcss.config.js
- quasar.config.js
- quasar.extensions.json
- quasar.testing.json
- README.md
- README.zh_CN.md
- tsconfig.json
- vitest.config.ts
- yarn.lock
# Installation Guide
1. Get the code
git clone https://github.com/ResearchHelper/research-helper
Downloads the entire project code from GitHub to your computer.
cd research-helper
Moves into the project folder you just downloaded.
2. Node.js
Easy RecommendedPrerequisites
yarn # strongly recommanded
Type this command into your terminal and run it.
npm install
Downloads and installs the libraries listed in package.json.
yarn dev # start electron app in development mode
Starts the development/run server.
yarn build # build the app
Builds optimized production files.
yarn debug # build the app with debugger
Type this command into your terminal and run it.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)
