/protostar-relay

The repo formally known as {proto*}

Primary LanguageJavaScriptMIT LicenseMIT

Proto Relay

Proto Relay is a Chrome extension devtool for React Relay based off the official devtool. It is designed to be light-weight, performant, and easy-to-use.

Table of Contents

  • insert table of contents later

Features

  • Preview Relay store content from the Chrome devtools panel
  • View store content over time with included snapshots
  • View store mutations and network queries

Installation

  1. Fork and clone this repository onto your local computer
  2. Install dependencies and run a build using either the 'Yarn' or 'NPM' commands below:
# Yarn
yarn npm install
yarn run build

# NPM
npm run install
npm run build
  1. Access the Chome extensions within the browser
  2. Access Chrome extensions within the browser
  3. Click on "Load Unpacked"
  4. Navigate and select the folder: protostar-relay > Shells > browser > chrome > build > unpacked
  5. Go to a website built with Relay and open the "proto*" panel. Websites that use Relay include:

How to Use

  • Example of how to access proto* and interact with the relay store.

  • Example of typing in the search box and resetting the store.

  • Example of interacting with snapshot feature and store timeline.

  • Example of navigating between the store and network.

Contributing

Protostar-relay is currently in beta release. We encourage you to submit issues for any bugs or ideas for enhancements. Also feel free to fork this repo and submit pull requests to contribute as well. Below are some features we would like to add as we iterate on this project:

  • Optimistic updates:
    • Visual representation.
    • List of all optimistic updates with pending/resolved status.
    • Control data flow.

Google Chrome Web Store

Get it on the Chrome Extension Store: coming soon.

Contributors

Aryeh Kobrinsky, Liz Lotto, Marc Burnie, Qwen Ballard

License

This project is licensed under the MIT License- see the LICENSE.md for more details.