Experiment with OpenAPI documentation

neuralinterfaces · Oct 8, 2023 · f3d3b45 · f3d3b45
1 parent 946de10
commit f3d3b45
Show file tree

Hide file tree

Showing 10 changed files with 4,633 additions and 11,118 deletions.
diff --git a/README.md b/README.md
@@ -16,7 +16,9 @@ Related services will be hosted using [Railway](https://railway.app/), where fol
 ## Running the Solidarity Demo
 To run the Python server, you'll need to create a `conda` environment from the `environment.yml` file.
 
-After this, activate the `solidarity` environment and run `npm run dev` to start the development server on your default browser or `npm start` to begin developing for desktop!
+After this, activate the `solidarity` environment (`conda activate solidarity`).
+
+You can then run `npm run dev` to start the development server on your default browser—or `npm start` to begin developing for desktop!
 
 ## Current Issues
 ### Railway Service Deployment

diff --git a/commoners.config.ts b/commoners.config.ts
@@ -1,12 +1,12 @@
-// ------------- PRODUCTION -------------
-import * as bluetoothPlugin from '@commoners/bluetooth'
-import * as serialPlugin from '@commoners/serial'
-// import { defineConfig } from 'commoners' // NOTE: COMMONERS dependencies are missing in local development...
+// // ------------- PRODUCTION -------------
+// import * as bluetoothPlugin from '@commoners/bluetooth'
+// import * as serialPlugin from '@commoners/serial'
+// // import { defineConfig } from 'commoners' // NOTE: COMMONERS dependencies are missing in local development...
 
-// // ------------- DEVELOPMENT -------------
-// import * as bluetoothPlugin from '../commoners/packages/plugins/devices/ble/index.js'
-// import * as serialPlugin from '../commoners/packages/plugins/devices/serial/index.js'
-// // import { defineConfig } from '../commoners/packages/core/index' // NOTE: COMMONERS dependencies are missing in local development...
+// ------------- DEVELOPMENT -------------
+import * as bluetoothPlugin from '../commoners/packages/plugins/devices/ble/index.js'
+import * as serialPlugin from '../commoners/packages/plugins/devices/serial/index.js'
+// import { defineConfig } from '../commoners/packages/core/index' // NOTE: COMMONERS dependencies are missing in local development...
 
 // // ----------- Package.json Dependencies -----------
 // // "@commoners/autoupdate": "file:../commoners/packages/plugins/autoupdate",
@@ -73,7 +73,7 @@ export default defineConfig({
             }
         },
         remote: 'https://jsonplaceholder.typicode.com',
-        remoteConfig: {
+        dynamic: {
             src: 'http://localhost:3768', // Call the python server in development
             publish: 'https://jsonplaceholder.typicode.com'
         }

diff --git a/index.html b/index.html
@@ -20,12 +20,16 @@
   <body>
     <div class="container">
       <h1>Solidarity ✊</h1>
-      <button id="testSerialConnection">Test Serial Connection</button>
-      <button id="testBluetoothConnection">Test Bluetooth Connection</button>
+      <main>
+        <ul id="commands">
+          <li>Connect to Serial Device <button id="testSerialConnection">Run</button></li>
+          <li>Connect to Bluetooth Device <button id="testBluetoothConnection">Run</button></li>
+        </ul>
 
-      <div id="console">
-        <ul id="sidecar-msg"></ul>
-      </div>
+        <div id="console">
+          <ul id="messages"></ul>
+        </div>
+      </main>
     </div>
   </body>
 </html>