A tool for Recoil developers
Download Chrome Extension»
View Demo App (Recoil Application)
Table of Contents
About The Project
Total RecoilJS is a tool created to help developers visualize and track their Recoil state via a Chrome extension.
Built With
Getting Started
To get a local copy up and running, follow these simple steps.
Prerequisites
Install React DevTools
https://chrome.google.com/webstore/detail/react-developer-tools/
Installation
- Clone the TotalRecoilJS github
git clone https://github.com/oslabs-beta/TotalRecoilJS.git
- Install NPM packages
npm install
- Start development server
npm run dev
-
Unpack to Google Chrome Extensions
-
Navigate to Extensions -> Load Unpacked -> Select Total-Recoil/build/extension
Usage
Visualize your component tree and see which components are subscribed to which atoms. When you click on an atom’s name, all components that are subscribed to that piece of state will light up.
Troubleshoot by seeing the current state held in each atom.
View list of previous states to track changes. On the history tab, you can see up to 10 previous state snapshots.
View all selector-atom subscriptions using our interactive sunburst and click on any selector to see all subscribed atoms.
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
License
Distributed under the MIT License. See LICENSE
for more information.
Authors
Anthony Lee - @linkedIn - @GitHub
Khizar Rehman - @linkedIn - @GitHub
Silvia Miranda - @linkedIn - @GitHub
Zi Hao He - @linkedIn - @GitHub
Kevin Ruan - @linkedIn - @GitHub