Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qri-io/desktop
Qri Desktop
https://github.com/qri-io/desktop
electron electron-app opendata
Last synced: 1 day ago
JSON representation
Qri Desktop
- Host: GitHub
- URL: https://github.com/qri-io/desktop
- Owner: qri-io
- License: gpl-3.0
- Created: 2019-07-03T17:49:36.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-02-12T18:54:01.000Z (over 3 years ago)
- Last Synced: 2024-08-03T15:14:29.069Z (3 months ago)
- Topics: electron, electron-app, opendata
- Language: TypeScript
- Homepage: https://qri.io/desktop
- Size: 7.06 MB
- Stars: 67
- Watchers: 8
- Forks: 14
- Open Issues: 101
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-starred - qri-io/desktop - Qri Desktop (electron)
README
[](https://qri.io) [](./LICENSE)
Qri Desktop
react, redux & electron webapp
Qri Desktop helps you manage your datasets
## Welcome
| Question | Answer |
|--------|-------|
| "I want to learn about Qri" | [Read the official documentation](https://qri.io/docs/) |
| "I want to run desktop in a development environment" | [Running Qri Desktop for dev](https://github.com/qri-io/desktop/README.md#running) |
| "I want to download the latest release of Qri Desktop" | [Download release](https://github.com/qri-io/desktop/releases) |
| "I have a question" | [Create an issue](https://github.com/qri-io/desktop/issues) and use the label 'question' |
| "I found a bug" | [Create an issue](https://github.com/qri-io/desktop/issues) and use the label 'bug' |
| "I want to help build the Qri webapp" | [Read the Contributing guides](https://github.com/qri-io/desktop/CONTRIBUTOR.md) |
# 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](https://github.com/qri-io/temp_registry_server), `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](https://qri.io/docs/reference/installing-qri-cli#configuring-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`
| 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](https://github.com/qri-io/desktop/blob/master/LICENSE)
## Contribute
We've set up a separate document for our [contributor guidelines](https://github.com/qri-io/desktop/blob/master/CONTRIBUTOR.md)!
## Develop
We've set up a separate document for [developer guidelines](https://github.com/qri-io/desktop/blob/master/DEVELOPER.md)!
###### This documentation has been adapted from the [Data Together](https://github.com/datatogether/datatogether), [Hyper](https://github.com/zeit/hyper), [AngularJS](https://github.com/angular/angularJS), and [Cycle.js](https://github.com/cyclejs/cyclejs) documentation.