Merge pull request #300 from oslabs-beta/dev

Dev

Author: benmarg

.babelrc

@@ -0,0 +1,6 @@
+{
+  "presets": [
+    "airbnb"
+  ],
+  "plugins": ["@emotion"]
+}

.editorconfig

@@ -0,0 +1,13 @@
+# EditorConfig  http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# All files
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true

.eslintrc

@@ -1,11 +1,19 @@
 {
-  "extends": ["airbnb", "plugin:jest/recommended"],
+  "extends": [
+    "airbnb", 
+    "plugin:jest/recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"],
   "root": true,
-  "plugins": ["jest", "react"],
+  "plugins": ["jest", "react", "react-hooks", "@typescript-eslint"],
   "rules": {
     "arrow-parens": [2, "as-needed"],
     "import/no-unresolved": "off",
-    "import/extensions": "off"
+    "import/extensions": "off",
+    "react-hooks/rules-of-hooks": "error", // Checks rules of Hooks
+    "react-hooks/exhaustive-deps": "warn", // Checks effect dependencies
+    "react/jsx-filename-extension": [0],
+    "linebreak-style": "off"
   },
   "env": {
     "es6": true,

.gitignore

@@ -1,4 +1,7 @@
 node_modules
+node_modules/
+/node_modules
+./node_modules
 .DS_Store
 src/extension/build/bundles
 package/reactime-*.tgz
@@ -8,4 +11,8 @@ coverage
 src/extension/build.zip
 src/extension/build.crx
 src/extension/build.pem
-bower_components
+bower_components
+sandboxes/manual-tests/NextJS/.next
+.vscode
+src/app/components/Map.tsx
+package-lock.json

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "tests/manual-tests/recoilTest"]
+	path = tests/manual-tests/recoilTest
+	url = https://github.com/kevinfey/recoilTest

.travis.yml

@@ -1,4 +1,14 @@
-services:
-  - docker
+language: node_js
+node_js:
+  - 12
+dist: trusty
+cache: npm
+git:
+  submodules: false
+# branches:
+#   only:
+#   - implementtravisci
+install:
+  - npm install
 script:
-  - docker-compose up --abort-on-container-exit
+  - npm run test

.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "eslint.enable": true,
+  "git.ignoreLimitWarning": true
+}

CONTRIBUTING.md

@@ -0,0 +1,70 @@
+# Welcome to the Reactime contributing guide!
+
+Thank you for investing your time in contributing to our project! :sparkles:. 
+
+In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
+
+## New contributor guide
+
+To get an overview of the project, read the [README](README.md). Here are some resources to help you get started with open source contributions:
+
+- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
+- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git)
+- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow)
+- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
+
+
+## Getting started
+
+To navigate our codebase with confidence, see the Developer READMEs [Developer Installation](/DeveloperREADME.md) and [Developer Guidelines](/src/README.md) :confetti_ball:.
+
+### Issues
+
+#### Create a new issue
+
+If you spot a problem with the docs, [search if an issue already exists](https://github.com/open-source-labs/reactime/issues). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/open-source-labs/reactime/issues/new). 
+
+#### Solve an issue
+
+Scan through our [existing issues](https://github.com/open-source-labs/reactime/issues) to find one that interests you. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
+
+### Make Changes
+
+#### Make changes in the UI
+
+Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review. 
+
+#### Make changes locally
+
+1. [Install Git LFS](https://docs.github.com/en/github/managing-large-files/versioning-large-files/installing-git-large-file-storage).
+
+2. Fork the repository.
+- Using GitHub Desktop:
+  - [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop.
+  - Once Desktop is set up, you can use it to [fork the repo](https://github.com/open-source-labs/reactime.git)!
+
+- Using the command line:
+  - [Fork the repo](https://github.com/open-source-labs/reactime.git) so that you can make your changes without affecting the original project until you're ready to merge them.
+
+3. Create a working branch and start with your changes!
+
+### Commit your update
+
+Commit the changes once you are happy with them.
+
+### Pull Request
+
+When you're finished with the changes, create a pull request, also known as a PR.
+- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request. 
+- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
+- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge.
+Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
+- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
+- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
+- If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues.
+
+### Your PR is merged!
+
+Congratulations :tada::tada: The Reactime team thanks you! :sparkles:. 
+
+Once your PR is merged, your contributions will be publicly visible on [Reactime](https://github.com/open-source-labs/reactime)!

DeveloperREADME.md

@@ -0,0 +1,46 @@
+<div>
+<h1>Development Enviroment Setup</h1>
+
+<h2>Getting Started</h2>
+
+1. <a href="https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en">Download React Dev Tools from the Chrome Webstore Here</a>
+
+2. Clone down the Reactime repo onto your machine.
+
+```
+git clone https://github.com/open-source-labs/reactime.git
+```
+
+3. Install dependencies and build.
+
+```
+cd reactime
+npm install --force
+npm run build
+```
+<b>With release of Node v18.12.1 (LTS) on 11/4/22, the script has been updated to 'npm run dev' || 'npm run build' for backwards compatibility.<br/>
+For version Node v16.16.0, please use script 'npm run devlegacy' || 'npm run buildlegacy'</b>
+
+4. Spin up the demo application.
+
+```
+cd demo-app
+npm install
+npm start
+```
+
+5. Add Reactime to your Chrome extensions.
+
+-   Navigate to chrome://extensions
+-   Select “Load Unpacked”
+-   Choose reactime > src > extension > build
+-   Navigate to http://localhost:8080/ to inspect the demo application using Reactime!
+    <br>
+
+<p align="center">
+  <img src="./assets/reactime-dev-setup.gif" />
+</p>
+
+<h2>Documentation for Consideration</h2>
+<h4>Can Reactime be integrated with Redux compatibility so applications using Redux can track state in Reactime?</h4>
+Yes, but it would be very time-consuming and not the most feasible option while Redux devtools exists already. With how Redux devtools is currently set up, a developer is unable to use Redux devtools as a third-party user and integrate its functionality into their own application, as Redux devtools is meant to be used directly on an application using Redux for state-tracking purposes. Since the devtools do not appear to have a public API for integrated use in an application or it simply does not exist, Redux devtools would need to be rebuilt from the ground up and then integrated into Reactime, or built into Reactime directly still from scratch.