research-helper

(β˜… 205)

THE reference manager with features including PDF reading/annotating, Markdown/Excalidraw note-taking, project/note linking, and more...

  • .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 Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
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