Qri Desktop

react, redux & electron webapp

Qri Desktop helps you manage your datasets

Website | Run in Dev Mode | Dependencies | Contribute | Issues | Docs | Download

Welcome

Question	Answer
"I want to learn about Qri"	Read the official documentation
"I want to run desktop in a development environment"	Running Qri Desktop for dev
"I want to download the latest release of Qri Desktop"	Download release
"I have a question"	Create an issue and use the label 'question'
"I found a bug"	Create an issue and use the label 'bug'
"I want to help build the Qri webapp"	Read the Contributing guides

Run Qri Desktop in developer mode

We use yarn to build and manage Qri Desktop.

After you have cloned this repository, install dependencies:

yarn

To run, start the qri backend in connected mode:

qri connect

Run in development mode (developer features enabled):

yarn dev

Run normally (no developer features):

yarn start

Run end to end tests:

• You'll need our temp_registry_server package to run e2e tests. You can either use the go get command (go get github.com/qri-io/temp_registry_server) or you can build it yourself by cloning the temp_registry_server repo, cd into the repo at the command line, running go install which will compile the binary for you (and likely put it in ~/go/bin) and then add that directory to your PATH. You'll know this was successful if you run the which temp_registry_server command and see the path to the binary.
• For macOS users run with yarn test-e2e which will also trigger a build, or run yarn test-e2e-no-build if you already have a build to test against
• For Windows users run yarn test-win-e2e or yarn test-win-e2e-no-build

To build the electron distributable package:

yarn dist

Main Dependencies

Dependency	Website	Github
Qri Backend	https://qri.io/	https://github.com/qri-io/qri/
React	https://reactjs.org/	https://github.com/facebook/react/
Redux	https://redux.js.org/	https://github.com/reduxjs/redux
Electron	https://electronjs.org/	https://github.com/electron/electron

LICENSE

GPL-3.0

Contribute

We've set up a separate document for our contributor guidelines!

Develop

We've set up a separate document for developer guidelines!

This documentation has been adapted from the Data Together, Hyper, AngularJS, and Cycle.js documentation.