Skip to content

Latest commit

 

History

History
118 lines (85 loc) · 4.88 KB

README.md

File metadata and controls

118 lines (85 loc) · 4.88 KB
Raw


Accelerate Your Research



Twitter Follow QQ Group Twitter Follow

English | 中文

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, 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 library-page.png

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 reader-page.png

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 note-page.png

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.