Documentation for Project IDX platform.

Author: riclolsen

README.md

@@ -171,7 +171,7 @@ To provide an easy to use, fully-featured, scalable, and portable SCADA/IIoT-I4.
 - [x] Install Script for RedHat/Rocky 9.4 Linux x86-64 and arm64
 - [ ] Linux Image / VM
 - [x] Supervisor (Linux process manager) examples
-- [ ] Project IDX Configuration
+- [x] Project IDX Configuration
 - [ ] InfluxDB Integration
 - [x] Telegraf Integration
 - [ ] Kafka Integration
@@ -186,6 +186,12 @@ To provide an easy to use, fully-featured, scalable, and portable SCADA/IIoT-I4.
 - [ ] Managed Cloud Service
 - [ ] Supported LTS versions
 
+## Spin up a free private instance on Google's Project IDX
+
+With just a Google account, you can spin up a free private instance for test/dev on Google's Project IDX. This is a great way to get started with the project. This will build the code from the Github repo and deploy it to a private Linux VM on the cloud running protocols and providing a web UI for you to interact with. There will be a web-based code editor available for you to develop new apps and view/change the code on the VM. You can also get help from Google's Gemini AI for coding and other tasks. This is free and there no need to install any software on your local machine.
+
+See details [here](https://github.com/riclolsen/json-scada/blob/master/platform-nix-idx/README.md). 
+
 ## Online Demo (substations simulation)
 
 - http://150.230.171.172

index.md

@@ -173,7 +173,7 @@ To provide an easy to use, fully-featured, scalable, and portable SCADA/IIoT-I4.
 - [x] Install Script for RedHat/Rocky 9.4 Linux x86-64 and arm64
 - [ ] Linux Image / VM
 - [x] Supervisor (Linux process manager) examples
-- [ ] Project IDX Configuration
+- [x] Project IDX Configuration
 - [ ] InfluxDB Integration
 - [x] Telegraf Integration
 - [ ] Kafka Integration
@@ -188,6 +188,12 @@ To provide an easy to use, fully-featured, scalable, and portable SCADA/IIoT-I4.
 - [ ] Managed Cloud Service
 - [ ] Supported LTS versions
 
+## Spin up a free private instance on Google's Project IDX
+
+With just a Google account, you can spin up a free private instance for test/dev on Google's Project IDX. This is a great way to get started with the project. This will build the code from the Github repo and deploy it to a private Linux VM on the cloud running protocols and providing a web UI for you to interact with. There will be a web-based code editor available for you to develop new apps and view/change the code on the VM. You can also get help from Google's Gemini AI for coding and other tasks. This is free and there no need to install any software on your local machine.
+
+See details [here](platform-nix-idx/README.md). 
+
 ## Online Demo (substations simulation)
 
 - http://150.230.171.172

platform-nix-idx/README.md

@@ -2,31 +2,35 @@
 
 Start a free instance for dev/test on Google's Project IDX platform with just a Google account.
 
-1 - Access the Project IDX platform, click on the "Get Started" button
+1. Access the Project IDX platform, click on the "Get Started" button. Connect your Google account if asked.
 
-    https://idx.dev
+    [https://idx.dev](https://idx.dev)
 
-2 - Create a new Workspace importing a GitHub repository.
+2. Create a new Workspace importing a GitHub repository.
 
-    URL: https://github.com/riclolsen/json-scada
-    Name: json-scada
+    * URL: https://github.com/riclolsen/json-scada
+    * Name: json-scada
 
-3 - Wait for the workspace to be imported and built. This will take a while, do not click the recover button.
+    Alternatively, you can fork the repo on Github and import it from there.
 
-4 - When started some terminals will open for initialize and build the project.
+3. Wait for the workspace to be imported and built. This will take a while, do not click the recover button. When started, some terminals will open to initialize and build the project. Wait until all the tasks are finished and the workspace is ready. This will take some minutes.
 
-5 - Wait until the tasks are finished and the workspace is ready. This will take some minutes.
+4. Click the Project IDX button on left sidebar and select "Backend Ports". Click the "Open New Window" action for port 8080. This will give access to the web UI for the project. Login with admin/jsonscada credentials.
 
-6 - Click the Project IDX button on left sidebar and select "Backend Ports".   
-
-7 - Click the "Open New Window" action for port 8080. This will give access to the web UI for the project. Login with admin/jsonscada credentials.
-
-8 - On the terminal control JSON-SCADA processes with the "supervisorctl" command. 
+5. On the VSCode's terminal, control JSON-SCADA processes with the "supervisorctl" command.  
 
+```bash
     supervisorctl status
     supervisorctl start all
     supervisorctl stop all
     supervisorctl restart all
-    supervisorctl start iec104client
+    supervisorctl stop iec104client
     supervisorctl start iec104client
     supervisorctl tail -f iec104client
+```
+
+Open the Gemini chat with Ctrl+Shift+Space.
+
+Notice that the provided free VM is a constrained environment with limited resources: 8GB RAM, 1-core CPUs, 10GB Disk.
+
+More info for Project IDX [here](https://developers.google.com/idx).