Merge pull request #48 from gobbledy-gook/Workflow

Create eslint.yml

.eslintignore

@@ -0,0 +1 @@
+myenv/

.eslintrc.json

@@ -0,0 +1,13 @@
+{
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "extends": "standard",
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "rules": {
+    }
+}

.github/workflows/eslint.yml

@@ -0,0 +1,19 @@
+name: Code Style Check
+
+on:
+  push:
+
+jobs:
+  style_check:
+    name: Style Check
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run ESLint
+        run: npx eslint .

.gitignore

@@ -34,3 +34,6 @@ test.db
 # secret keys
 report_ai.pem
 dev.sh
+
+# node modules
+/node_modules

CONTRIBUTING.md

@@ -18,6 +18,8 @@ Users are encouraged to use GitHub Discussions for engaging with researchers, de
 
 Code in this repository should conform to PEP8 standards. Style/lint checks are run to validate this. Line length must be limited to no more than 88 characters.
 
+All the Javascript code must confirm to [Standard](https://standardjs.com/rules.html) Js styling
+
 ### Pull Request Checklist
 
 When submitting a pull request and you feel it is ready for review,
@@ -32,6 +34,12 @@ please ensure that:
    black .
    ```
    from the root of the repository clone for lint conformance checks.
+2. To Check the Code style of Javascript, test usign ESLint standard
+   you can run
+   ```shell
+   npx eslint .
+   ```
 
 ### Tox commands available
 - To Fix the black violation <code> black <PATH_FILE_YOU_WANT_TO_FIX> </code>
+- To Fix the some of the ESLint violations <code> npx eslint . --fix <PATH_FILE_YOU_WANT_TO_FIX> </code>

INSTALLATION.md

@@ -0,0 +1,62 @@
+# Report.ai
+
+## Installation from CRX
+
+1. Download the Extension:
+   Download the extension CRX file from the Release
+   Make sure to save the CRX file to a location on your computer that you can easily access.
+
+2. Install the Extension:
+   Open Google Chrome browser on your computer.
+   In a new tab, type chrome://extensions in the address bar and press Enter.
+   This will open the Chrome Extensions page.
+
+3. Enable Developer Mode:
+   At the top-right corner of the Chrome Extensions page, you will find a toggle switch labeled "Developer mode".
+   Enable the "Developer mode" toggle switch by clicking on it.
+
+4. Install the Extension from the CRX File:
+   Locate the CRX file you downloaded in step 1.
+   Drag and drop the CRX file onto the Chrome Extensions page.
+   Alternatively, you can click on the "Load unpacked" button that appears on the Chrome Extensions page and select the CRX file from the file browser.
+
+5. Confirm the Installation:
+   A prompt will appear asking for confirmation to install the extension.
+   Click on "Add extension" or "Yes" to proceed with the installation.
+
+6. Extension Installed:
+   Once the installation is complete, you will see the extension listed on the Chrome Extensions page.
+   The extension should now be installed and ready to use in your Chrome browser.
+
+## Installation from ZIP file
+
+1. Download the Extension:
+   Click on the following link to download the extension ZIP file from the Release
+   Save the ZIP file to a location on your computer that you can easily access.
+
+2. Extract the ZIP File:
+   Locate the downloaded ZIP file on your computer.
+   Right-click on the ZIP file and choose "Extract All" or use a compression tool to extract the contents of the ZIP file.
+   Choose a destination folder to extract the contents.
+
+3. Open Google Chrome Extensions Page:
+   Open Google Chrome browser on your computer.
+   In a new tab, type chrome://extensions in the address bar and press Enter.
+   This will open the Chrome Extensions page.
+
+4. Enable Developer Mode:
+    At the top-right corner of the Chrome Extensions page, you will find a toggle switch labeled "Developer mode".
+    Enable the "Developer mode" toggle switch by clicking on it.
+
+5. Load Unpacked Extension:
+    On the Chrome Extensions page, click on the "Load unpacked" button.
+    In the file browser dialog, navigate to the folder where you extracted the contents of the ZIP file in step 2.
+    Select the folder containing the extension's files and click "Select" or "Open".
+
+6. Confirm the Installation:
+    The extension will be loaded and added to the list of installed extensions.
+    Ensure that the extension is enabled by toggling the switch next to it.
+
+7. Extension Installed:
+    Once the installation is complete, you should see the extension listed on the Chrome Extensions page.
+    The extension should now be installed and ready to use in your Chrome browser.

README.md

@@ -13,6 +13,8 @@
 2. Open your web browser and go to `chrome://extensions/`.
 3. Click on `Load unpacked` and select the extracted folder from Step 1.
 
+Having troubles? Read the [installation guide](./INSTALLATION.md)
+
 ## **Dev Installation**
 
 1. Clone the repository on your local machine using -