Qrimatic

react, redux, typescript web application

Qrimatic is our new cloud platform for keeping data fresh, shareable, discoverable, and usable.

Qri Website | Run in Dev Mode | Run e2e tests | Dependencies | Contribute | Issues | Docs

Welcome

Question	Answer
"I want to learn about Qri"	Read the official documentation
"I want to run Qrimatic in a development environment"	Running Qrimatic for dev
"I want to run the Qrimatic e2e tests"	Run e2e tests
"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 Qrimatic"	Read the Contributing guides

Run Qrimatic in developer mode

We use yarn to build and manage Qrimatic. The frontend app needs an API to talk to. You can use the live staging API or set up a local proxy and run the app with the environment variable REACT_APP_API_BASE_URL defined

After you have cloned this repository, install dependencies:

yarn

Run the development server:

yarn start

run the e2e tests

run locally

To run the e2e tests locally, you must be able to run and instance of qri & an instance of the frontend app

1. launch the frontend app (yarn start)
2. in your local qri config, add "http:localhost:3000" to your API.allowedOrigins
3. in another terminal, launch the qri app (qri connect)
4. set your credentials as environment variables: TEST_E2E_USERNAME is your local qri node's username TEST_E2E_PASSWORD is your password
5. run yarn e2e-test to run your tests

run via cloud

To run the e2e tests via the staging cloud environment you must have an accound on rosebud.qri.cloud that has been cleared by an administrator. For help, please reach out to us on discord.

1. set your credentials as environment variables: TEST_E2E_USERNAME is your qri cloud username TEST_E2E_PASSWORD is your password
2. set your app url environment variable: TEST_E2E_APP_URL="https://rosebud.qri.cloud"
3. run yarn e2e-test

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

LICENSE

GPL-3.0

Contribute

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

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