Accelerate Your Research

English | 中文

Research Helper

Research helper is a paper/book management tool. It is a reference management tool with various useful functionalities such as: built-in PDF reader, live markdown note and excalidraw note.

Reference Management

References can be managed in library page.

• Favorites, folders, tags, search, etc. All essential functions are there
• Able to one-click-retrieve meta information and related reference by providing identifier such as DOI

PDF Reader

Research helper has a built-in PDF reader.

• Able to adjust page layout, light/dark mode and more
• Support markdown comment (also latex) in annotations
• Able to preview internal links in hover windows

Note-taking System

Due to the flexible multi-window layout, it is never this easy to take notes while reading.

• Support WYSIWYG markdown note and excalidraw note
• Able to cite other references/notes in markdown note
• Support math(latex), code block, mindmap and more in markdown down

Contribute to Research-Helper

Research Helper uses QUASAR as framework. In this project, the combination of Vue.js3 and Electron is used.

Install the dependencies

yarn # strongly recommanded
# or
npm install

Start the electron app in development mode (hot-code reloading, error reporting, etc.)

yarn dev # start electron app in development mode

To build the app

yarn build # build the app
# or 
yarn debug # build the app with debugger 

Tests

yarn test:unit:ci # backend unit test
yarn test:component:ci # vue component test

Acknowledgement

This project is made possible by the following open source projects.

• Quasar
• Electron
• Vue.js
• citation-js
• cytoscape
• golden-layout
• pdf.js
• vditor
• Pouchdb
• Excalidraw

License

This project uses AGPL license.