ResearchHelper/research-helper

use

Closed this issue · 4 comments

yangxiongj commented

image
image
I can't understand how to use it

HuntFeng commented
  • If you want to use the app only, download the corresponding executable in the newest release.
  • If you want to contribute (or develop your own version of research-helper), you can do the followings
  1. Clone the project, and cd into the project folder
git clone git@github.com:ResearchHelper/research-helper.git
cd research-helper
  1. Install dependencies (yarn is recommended)
yarn
  1. Start development
yarn dev

By doing yarn dev, pouchdb-server will be automatically started on port 3000 for debugging. You can use the built-in pouchdb utils by accessing http://localhost:3000/_utils/ in your browser.

If you want to develop a cloud storage feature, you will need to use CouchDB for production rather than pouchdb server.

yangxiongj commented

Do you have a web version, not an exe

yangxiongj commented

Grammar compatibility is really impressiveGrammar compatibility is really impressive

HuntFeng commented

Since the app needs to store data in your computer, I'm not so sure web version is a good idea.

But I get it, you can use something like grammarly if it's a web. I'll consider this feature after plugin system is implemented.