TotalRecoilJS

<!-- PROJECT SHIELDS --> <!-- *** I'm using markdown "reference style" links for readability. *** Reference links are enclosed in brackets [ ] instead of parentheses ( ). *** See the bottom of this document for the declaration of the reference variables *** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use. *** https://www.markdownguide.org/basic-syntax/#reference-style-links --> <!-- [![Contributors][contributors-shield]][contributors-url] --> <!-- [![Stargazers][stars-shield]][stars-url] [![LinkedIn][linkedin-shield]][linkedin-url] --> <!-- PROJECT LOGO --> <br /> <p align="center"> <a href="https://github.com/oslabs-beta/TotalRecoilJS"> <img src="src/icons/Recoil-PNG-Gray.png" alt="Logo" width="200" > </a> <!-- <h3 align="center">TotalRecoilJS</h3> --> <p align="center"> A tool for Recoil developers <br /> <a href="https://chrome.google.com/webstore/detail/recoil-dev-tools/dhjcdlmklldodggmleehadpjephfgflc"><strong>Download Chrome Extension»</strong></a> <br /> <br /> <a href="https://github.com/silvia-miranda/RecoilTravel">View Demo App (Recoil Application)</a> </p> </p> <!-- TABLE OF CONTENTS -->

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• License
• Authors
• Acknowledgements

<!-- ABOUT THE PROJECT -->

About The Project

Total RecoilJS is a tool created to help developers visualize and track their Recoil state via a Chrome extension.

Built With

• React
• D3
• TypeScript
• Chrome DevTools

<!-- GETTING STARTED -->

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

1. Clone the TotalRecoilJS github

git clone https://github.com/oslabs-beta/TotalRecoilJS.git

2. Install NPM packages

npm install

3. Start development server

npm run dev

4. Unpack to Google Chrome Extensions

5. Navigate to Extensions -> Load Unpacked -> Select Total-Recoil/build/extension

<!-- USAGE EXAMPLES -->

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.

<insert gif of atom state>

View list of previous states to track changes. On the history tab, you can see up to 10 previous state snapshots.

<insert gif of history>

View all selector-atom subscriptions using our interactive sunburst and click on any selector to see all subscribed atoms.

<insert gif of sunburst image>

<!-- CONTRIBUTING -->

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 -->

License

Distributed under the MIT License. See LICENSE for more information.

<!-- CONTACT -->

Authors

<strong>Anthony Lee - @linkedIn - @GitHub

<strong>Khizar Rehman - @linkedIn - @GitHub

<strong>Silvia Miranda - @linkedIn - @GitHub

<strong>Zi Hao He - @linkedIn - @GitHub

<strong>Kevin Ruan - @linkedIn - @GitHub

<!-- ACKNOWLEDGEMENTS -->

Acknowledgements

Denys Dekhtiarenko - @linkedIn - @GitHub

<!-- MARKDOWN LINKS & IMAGES --> <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->