Merge pull request #85 from reactrewind/dev

Dev

Author: murphybrandon

.eslintrc.json

@@ -0,0 +1,21 @@
+{
+  "extends": ["airbnb"],
+  "rules": {
+    "react/prop-types": 0,
+    "no-console": 1
+  },
+  "plugins": ["react", "import"],
+  "parser": "babel-eslint",
+  "parserOptions": {
+    "ecmaVersion": 2018,
+    "sourceType": "module",
+    "ecmaFeatures": {
+      "jsx": true
+    }
+  },
+  "env": {
+    "es6": true,
+    "browser": true,
+    "node": true
+  }
+}

.gitignore

@@ -1 +1,5 @@
 /node_modules
+src/browser/chrome/devtools_bundle
+.DS_Store
+src/.DS_Store/
+

.prettierrc

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 React Rewind <reactrewindjs@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENCE

@@ -0,0 +1,74 @@
+<p align="center">
+  <img src ="./images/greygreen_gg_full_350w.png" width="200"/>
+</p>
+
+# Rewind: A Time Travel Debugger for React *useReducer*
+
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/reactrewind/react-rewind/pulls) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+![Release Beta](https://img.shields.io/badge/release-beta-blue.svg)<br/><br/>
+ Designed to help engineers fix bugs faster by recording and replaying through different states of their applications. Debug your app more easily by “rewinding” your session instead of having to reproduce the issue until you find the problem. <br/>
+
+
+
+- Press record and start interacting with your application.
+- Each dispatched action will be stored as a unique event in time.
+- Rewind through your recorded actions with the back button or by dragging the slider.
+- Analyze the state, the effects and the action object of every disptached event.
+- Press play and watch your app change!
+<p align="center">
+  <img src ="images/BrowserPreview_tmp.gif" width="600">
+</p>
+
+ **React Rewind is in active development. Follow this repo for contribution guidelines.**
+## Getting Started
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
+
+### Prerequisites
+Your application must be using the hook `useReducer` for actions to be recorded.
+
+### Installing
+React Rewind will soon be available as a Chrome extension through the Google Chrome Web Store.
+
+To install locally, setup instructions are as follows:
+
+1. `git clone https://github.com/reactrewind/react-rewind.git`
+2. `cd react-rewind`
+3. `npm run install_dep`
+4. `npm run build`
+5. Visit the URL `chrome://extensions/`
+6. Click Load Unpacked button and select the folder `react-rewind/src/browser/chrome`
+7. On your application page, open the Chrome Developer tools and select `React Rewind` from the tool bar
+8. Click Record and begin interacting with your application
+
+
+As you interact with your application, actions will populate the events panel. Click on these actions to view more details about them, such as the action object that was dispatched, the effects or state difference, and the whole state of the application after the dispatch. The time slider panel allows you to rewind, fast forward, and play through all recorded actions.
+
+### Application Features
+<p align="center">
+  <img src ="images/effects_900w.gif" width="700" />
+</p>
+
+| Field  | Description |
+| ------------- | ------------- |
+| events  | action types and time since last dispatch |
+| actions  | the action object that was dispatched |
+| effects  | difference between the states before and after the action was dispatched  |
+| state  | the state object after the action was dispatched  |
+
+## Contributing
+
+Please fork this repo.  We welcome pull requests. For suggestions or to report bugs please log an issue.
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). 
+
+## Authors
+
+[Brandon Murphy](https://github.com/murphybrandon) | [Victor Varaschin](https://github.com/victorvrv) | [Kia Colbert](https://github.com/kiacolbert) | [Gaber Mowiena](https://github.com/GaberMowiena)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENCE.md](./LICENCE) file for details
+

README.md

@@ -2,9 +2,7 @@
   "extends": [
     "eslint:recommended",
     "plugin:import/errors",
-    "plugin:react/recommended",
-    "prettier",
-    "prettier/react"
+    "plugin:react/recommended"
   ],
   "rules": {
     "react/prop-types": 0,