Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ResearchHelper/research-helper
THE reference manager with features including PDF reading/annotating, Markdown/Excalidraw note-taking, project/note linking, and more...
https://github.com/ResearchHelper/research-helper
citation excalidraw markdown note note-taking pdf pdf-annotator pdf-viewer reference-manager wysiwyg-markdown
Last synced: about 1 month ago
JSON representation
THE reference manager with features including PDF reading/annotating, Markdown/Excalidraw note-taking, project/note linking, and more...
- Host: GitHub
- URL: https://github.com/ResearchHelper/research-helper
- Owner: ResearchHelper
- License: agpl-3.0
- Created: 2022-08-29T05:12:08.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-08T22:17:04.000Z (10 months ago)
- Last Synced: 2024-06-10T19:11:15.964Z (3 months ago)
- Topics: citation, excalidraw, markdown, note, note-taking, pdf, pdf-annotator, pdf-viewer, reference-manager, wysiwyg-markdown
- Language: Vue
- Homepage: https://researchhelper.github.io
- Size: 90.3 MB
- Stars: 194
- Watchers: 5
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Accelerate Your Research
# [Sophosia](https://github.com/sophosia/sophosia) Has Been Released！
Thank you all for supporting Reasearch Helper. In the year of 2023, I received many useful suggestions, and the beta version of the Research Helper had accomplished its goal, there will be no feature updates in the future. The new version, [Sophosia](https://github.com/sophosia/sophosia), will be the version with continuous support and updates. The main differences between the new version and the beta version are:
1. The new version removes the PouchDB database, all data is text-centric.
2. The new version uses Tauri instead of Electron.
There will be a few benefits:
1. By removing PouchDB, users can choose their favorite tools for cloud syncing.
2. Being text-centric allows users to choose their preferred text editor for note-taking, without worrying about data consistency between different softwares.
3. The new version becomes very lightweight (~15MB).
I hope everyone continues to support Sophosia!
# 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](https://quasar.dev) as framework. In this project, the combination of [Vue.js3](https://vuejs.org) and [Electron](https://www.electronjs.org) is used.
## Install the dependencies
```bash
yarn # strongly recommanded
# or
npm install
```
## Start the electron app in development mode (hot-code reloading, error reporting, etc.)
```bash
yarn dev # start electron app in development mode
```
## To build the app
```bash
yarn build # build the app
# or
yarn debug # build the app with debugger
```
## Tests
```bash
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.