Merge pull request #164 from ControlCore-Project/main

Sync from main

Author: pradeeban

.eslintrc.js

@@ -0,0 +1,74 @@
+module.exports = {
+    parser: 'babel-eslint',
+    env: {
+        browser: true,
+        es2021: true,
+    },
+    extends: [
+        'plugin:react/recommended',
+        'airbnb',
+    ],
+    parserOptions: {
+        ecmaFeatures: {
+            jsx: true,
+        },
+        ecmaVersion: 12,
+        sourceType: 'module',
+    },
+    plugins: [
+        'react',
+    ],
+    rules: {
+        indent: [
+            'error',
+            4,
+        ],
+        'react/jsx-indent': [
+            'error',
+            4,
+        ],
+        'react/jsx-indent-props': [
+            'error',
+            4,
+        ],
+        'max-len': [
+            'error',
+            {
+                code: 120,
+                ignoreUrls: true,
+                ignoreComments: true,
+            },
+        ],
+        'keyword-spacing': 'warn',
+        'space-infix-ops': 'error',
+        'no-unused-vars': [
+            'warn',
+            {
+                vars: 'all',
+                args: 'after-used',
+                ignoreRestSiblings: false,
+            },
+        ],
+        'react/prop-types': 'off',
+        'linebreak-style': ['error', (process.platform === 'win32' ? 'windows' : 'unix')],
+    },
+    overrides: [
+        {
+            files: [
+                '*ML.js',
+            ],
+            rules: {
+                indent: [
+                    'error',
+                    2,
+                ],
+            },
+        },
+    ],
+    settings: {
+        'import/ignore': [
+            '.css$',
+            'node_modules/*',
+        ],
+    },
+};

.eslintrc.json

@@ -1,12 +1,19 @@
 name: Build and Deploy
+
 on: workflow_dispatch
 jobs:
   build-and-deploy:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [16.x]
     steps:
       - name: Checkout 🛎️
         uses: actions/checkout@v2.3.1
-
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
       - name: Install and Build 🔧 
         run: |
           npm ci

.github/workflows/buildAndDeploy.yml

@@ -2,8 +2,6 @@
 
 This is a fork of DHGWorkflow, visual Directed Hypergraph Workflow Composer, finetuned to operate as a frontend for _concore_.
 
-Active development of the _concore_ Editor happens in the dev branch. Please check it out!
-
 Key Features of the _concore_ Editor:
 * Export-import graph as a graphml file.
 * Export graph as JPEG/PNG
@@ -22,8 +20,9 @@ Steps to start it locally
 2. At the root of the repository, run the following commands:
     1. `npm i`
     2. `npm start`
-3. It should a development server and tool will be accessible at
+3. It should start a development server and tool will be accessible at
     `http://localhost:3000/DHGWorkflow`
+4. Note - In case, you're using Windows and see the linebreak-error please modify line 53 in `.eslintrc.json` file to `"linebreak-style": ["error", "windows"]`. Make sure you do not commit this change to prevent default environment.
 
 ## Creating a generic Graph Builder.
 
@@ -35,6 +34,25 @@ This branch will be synced with the changes from the main periodically. Easy to
 2. `npm i`
 3. `npm start`
 
+If this throws a long error in the browser and console about line endings (LF/CRLF), please follow the below steps.
+
+In  ~/.gitconfig, set autocrlf to false as below.
+````
+[core]
+         autocrlf = false
+````
+
+Then run the below from the concore editor source code in terminal.
+
+````
+git rm --cached -r .
+git reset --hard
+git pull --rebase
+````
+
+Now re-run with npm as above.
+
+
 This branch may contain `src/graph-builder/tailored-graph-builder.js`. It can be safely removed.
 
 ### 2. Make changes to the master branch
@@ -53,4 +71,21 @@ This project requires building a graph with some special kind of hyperedges.
 
 If we create our instance of the graph with `tailored-graph-builder`, we will get graph builder which will have hyperedges specialized for this project requirement whereas creating the instance from `graph-core` will result in a generic graph builder with simple edges.
 
-  
+# Deploying concore-editor in GitHub
+
+If you have forked this repository, make sure to configure the GitHub actions. This is done *only once* for the entire GitHub deployment. Go to your fork's settings/pages (for example, https://github.com/pradeebanlab/concore-editor/settings/pages), and enable the GitHub Pages as shown below.
+
+![The Pages Configuration](figures/github-pages.png)
+
+Once this is configured, every time you want to update the hosted concore-editor, you need to run the "Build and Deploy" action as elaborated below.
+
+We have two workflows.
+
+* Build - triggers automatically on every push and pull just to ensure the new PRs are consistent.
+
+* Build and Deploy - This has to be triggered manually and updates the online deployed version. This ensures that any PR containing breaking change doesn't affect the user directly
+ 
+
+Please go to the url https://github.com/ControlCore-Project/concore-editor/actions/workflows/buildAndDeploy.yml and trigger this particular workflow. This will in turn automatically trigger the Pages Build and Deploy action. Once that action also completes successfully, the new page will be alive. Depending on the nature of the changes, you may need to clear the cache/cookies to make the changes visible to your browser. You can choose to delete just the cookies and data of controlcore-project.github.io as stored in your browser. Please check the browser documentation for more information on deleting the cookies.
+
+ 

README.md

@@ -0,0 +1 @@
+A placeholder for screenshots