BallyBots

https://github.com/williamsokol/esp32robots
Admin
This repository contains the development source code for BallyBots, interactive robots that users...
Tokens:217,825
Snippets:3,347
Trust Score:6.1
License:Apache-2.0
Update:3 months ago
Show doc for...
Tokens:
Raw
### Initialize an Express Application

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32_Stream_Robot3_littlefire/NodeServer/node_modules/express/Readme.md

Commands to install the generator, create a new project, install dependencies, and start the server.

```console
$ npm install -g express-generator@4
```

```console
$ express /tmp/foo && cd /tmp/foo
```

```console
$ npm install
```

```console
$ npm start
```

--------------------------------

### Install on-finished

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/on-finished/README.md

Install the package via npm.

```sh
$ npm install on-finished
```

--------------------------------

### Install ee-first

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/ee-first/README.md

Use npm to install the package in your project.

```sh
$ npm install ee-first
```

--------------------------------

### Generate and Start an Express App

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/express/Readme.md

Commands to create a new application directory, install required dependencies, and launch the server.

```console
$ express /tmp/foo && cd /tmp/foo
```

```console
$ npm install
```

```console
$ npm start
```

--------------------------------

### Install serve-static

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/serve-static/README.md

Use npm to install the package locally in your project.

```sh
$ npm install serve-static
```

--------------------------------

### Install utf-8-validate

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/utf-8-validate/README.md

Command to install the package as an optional dependency.

```bash
npm install utf-8-validate --save-optional
```

--------------------------------

### Install gotrue-js

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/@supabase/gotrue-js/README.md

Install the library using npm.

```bash
npm install --save @supabase/gotrue-js
```

--------------------------------

### Install media-typer

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/media-typer/README.md

Use npm to install the package in your project.

```sh
$ npm install media-typer
```

--------------------------------

### Install and Test Commands

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/mime/README.md

Commands for installing the package and running tests.

```bash
npm install mime
```

```bash
npm run test
```

--------------------------------

### Install function-bind

Source: https://github.com/williamsokol/esp32robots/blob/main/WifiSystems/GlobalWifiwebsocketIO/NodeServer/node_modules/function-bind/README.md

Command to install the package via npm.

```bash
npm install function-bind
```

--------------------------------

### Install the methods package

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/methods/README.md

Use npm to install the package as a dependency in your project.

```bash
$ npm install methods
```

--------------------------------

### Install Negotiator

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/negotiator/README.md

Use npm to install the package in your project.

```sh
$ npm install negotiator
```

--------------------------------

### Install content-type

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/content-type/README.md

Use npm to install the package in your project.

```sh
$ npm install content-type
```

--------------------------------

### Clone and Run Express Examples

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/express/Readme.md

Steps to download the official repository and execute specific example applications.

```console
$ git clone git://github.com/expressjs/express.git --depth 1
$ cd express
$ npm install
```

```console
$ node examples/content-negotiation
```

--------------------------------

### Install proxy-addr

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/proxy-addr/README.md

Install the module via npm.

```sh
$ npm install proxy-addr
```

--------------------------------

### Install node-gyp-build

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/node-gyp-build/README.md

Install the package via npm.

```bash
npm install node-gyp-build
```

--------------------------------

### Install ext package

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/ext/README.md

Use npm to install the library as a dependency in your project.

```bash
npm install ext
```

--------------------------------

### Install WebSocket library

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/websocket/README.md

Use npm to install the package in your project root.

```bash
$ npm install websocket
```

--------------------------------

### Install storage-js

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/@supabase/storage-js/README.md

Install the package via npm.

```bash
npm install @supabase/storage-js
```

--------------------------------

### Install Realtime JS

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/@supabase/realtime-js/README.md

Use npm to install the package in your project.

```bash
npm install @supabase/realtime-js
```

--------------------------------

### Install cross-fetch

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/cross-fetch/README.md

Install the package using npm.

```sh
npm install --save cross-fetch
```

--------------------------------

### Install the type library

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/ext/node_modules/type/README.md

Command to install the package via npm.

```bash
npm install type
```

--------------------------------

### Install the d package

Source: https://github.com/williamsokol/esp32robots/blob/main/WifiSystems/GlobalWifiwebsocketIO/NodeServer/node_modules/d/README.md

Command to install the package via npm.

```bash
$ npm install d
```

--------------------------------

### Install type-is

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/type-is/README.md

Command to install the package via npm.

```sh
$ npm install type-is
```

--------------------------------

### Installation via NPM

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/object-inspect/readme.markdown

Command to install the package using npm.

```bash
npm install object-inspect
```

--------------------------------

### Install has library

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/has/README.md

Use npm to install the package as a dependency.

```sh
npm install --save has
```

--------------------------------

### Install the IP library

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/ip/README.md

Commands to install the library via npm or clone the repository from GitHub.

```shell
npm install ip
```

```shell
git clone https://github.com/indutny/node-ip.git
```

--------------------------------

### Install array-flatten

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/array-flatten/README.md

Use npm to install the package as a dependency.

```bash
npm install array-flatten --save
```

--------------------------------

### Install statuses package

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/statuses/README.md

Use npm to install the module locally.

```sh
$ npm install statuses
```

--------------------------------

### Install postgrest-js

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/@supabase/postgrest-js/README.md

Use npm to install the package in your project.

```bash
npm install @supabase/postgrest-js
```

--------------------------------

### Install ws library

Source: https://github.com/williamsokol/esp32robots/blob/main/NodeJS-CommandStream-Server/node_modules/ws/README.md

Command to install the ws package via npm.

```bash
npm install ws
```

--------------------------------

### Install Send via NPM

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/send/README.md

Use this command to install the library in your Node.js project.

```bash
$ npm install send
```

--------------------------------

### Install es5-ext via npm

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/es5-ext/README.md

Use this command to install the package in your project.

```bash
npm install es5-ext
```

--------------------------------

### Install content-disposition

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/content-disposition/README.md

Command to install the package via npm.

```sh
$ npm install content-disposition
```

--------------------------------

### Install accepts via npm

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/accepts/README.md

Use the npm command to install the accepts package in your project.

```sh
$ npm install accepts
```

--------------------------------

### Install Supabase JS

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/@supabase/supabase-js/README.md

Use npm to install the library in your project.

```sh
npm install @supabase/supabase-js
```

--------------------------------

### Install optional performance modules

Source: https://github.com/williamsokol/esp32robots/blob/main/NodeJS-CommandStream-Server/node_modules/ws/README.md

Commands to install optional binary addons for improved performance in masking and UTF-8 validation.

```bash
npm install --save-optional bufferutil
```

```bash
npm install --save-optional utf-8-validate
```

--------------------------------

### Install bufferutil

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/bufferutil/README.md

Install the package as an optional dependency using npm.

```bash
npm install bufferutil --save-optional
```

--------------------------------

### Configure package.json install script

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/node-gyp-build/README.md

Add node-gyp-build to the install script in your package.json file.

```json
{
  ...
  "scripts": {
    "install": "node-gyp-build"
  }
}
```

--------------------------------

### Install toidentifier via npm

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/toidentifier/README.md

Use the npm command to install the package in your project.

```bash
$ npm install toidentifier
```

--------------------------------

### Install utils-merge

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/utils-merge/README.md

Install the package via npm.

```bash
$ npm install utils-merge
```

--------------------------------

### Serve files using Express

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/serve-static/README.md

Examples demonstrating basic Express integration, multiple directory roots, and path-specific settings.

```js
var express = require('express')
var serveStatic = require('serve-static')

var app = express()

app.use(serveStatic('public/ftp', { index: ['default.html', 'default.htm'] }))
app.listen(3000)
```

```js
var express = require('express')
var path = require('path')
var serveStatic = require('serve-static')

var app = express()

app.use(serveStatic(path.join(__dirname, 'public-optimized')))
app.use(serveStatic(path.join(__dirname, 'public')))
app.listen(3000)
```

```js
var express = require('express')
var path = require('path')
var serveStatic = require('serve-static')

var app = express()

app.use(serveStatic(path.join(__dirname, 'public'), {
  maxAge: '1d',
  setHeaders: setCustomCacheControl
}))

app.listen(3000)

function setCustomCacheControl (res, path) {
  if (serveStatic.mime.lookup(path) === 'text/html') {
    // Custom Cache-Control for HTML files
    res.setHeader('Cache-Control', 'public, max-age=0')
  }
}
```

--------------------------------

### Install depd

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/depd/Readme.md

Install the module using npm.

```sh
$ npm install depd
```

--------------------------------

### Initialize StorageClient

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/@supabase/storage-js/README.md

Connect to the storage backend using the project URL and a service role key.

```js
import { StorageClient } from '@supabase/storage-js'

const STORAGE_URL = 'https://<project_ref>.supabase.co/storage/v1'
const SERVICE_KEY = '<service_role>' //! service key, not anon key

const storageClient = new StorageClient(STORAGE_URL, {
  apikey: SERVICE_KEY,
  Authorization: `Bearer ${SERVICE_KEY}`,
})
```

--------------------------------

### Run iconv-lite tests and performance benchmarks

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/iconv-lite/README.md

Commands to clone the repository, install dependencies, run tests, check performance, and generate coverage reports.

```bash
$ git clone git@github.com:ashtuchkin/iconv-lite.git
$ cd iconv-lite
$ npm install
$ npm test
    
$ # To view performance:
$ node test/performance.js

$ # To view test coverage:
$ npm run coverage
$ open coverage/lcov-report/index.html
```

--------------------------------

### Create a basic Express server

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/express/Readme.md

Initializes an Express application and starts a server listening on port 3000.

```js
const express = require('express')
const app = express()

app.get('/', function (req, res) {
  res.send('Hello World')
})

app.listen(3000)
```

--------------------------------

### Install safe-buffer

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/safe-buffer/README.md

Command to install the package via npm.

```bash
npm install safe-buffer
```

--------------------------------

### Install yaeti

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/yaeti/README.md

Use npm to install the package as a dependency.

```bash
$ npm install yaeti --save
```

--------------------------------

### Command Line Usage

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/mime/README.md

Example of using the mime command line tool.

```bash
mime [path_string]
```

```bash
> mime scripts/jquery.js
application/javascript
```

--------------------------------

### Install typedarray-to-buffer

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/typedarray-to-buffer/README.md

Use npm to install the package in your project.

```bash
npm install typedarray-to-buffer
```

--------------------------------

### Configure WebSocket server compression

Source: https://github.com/williamsokol/esp32robots/blob/main/NodeJS-CommandStream-Server/node_modules/ws/README.md

Example of initializing a WebSocketServer with custom permessage-deflate settings.

```javascript
import WebSocket, { WebSocketServer } from 'ws';

const wss = new WebSocketServer({
  port: 8080,
  perMessageDeflate: {
    zlibDeflateOptions: {
      // See zlib defaults.
      chunkSize: 1024,
      memLevel: 7,
      level: 3
    },
    zlibInflateOptions: {
      chunkSize: 10 * 1024
    },
    // Other options settable:
    clientNoContextTakeover: true, // Defaults to negotiated value.
    serverNoContextTakeover: true, // Defaults to negotiated value.
    serverMaxWindowBits: 10, // Defaults to negotiated value.
    // Below options specified as default values.
    concurrencyLimit: 10, // Limits zlib concurrency for perf.
    threshold: 1024 // Size (in bytes) below which messages
    // should not be compressed if context takeover is disabled.
  }
});
```

--------------------------------

### Install dotenv

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/dotenv/README.md

Install the package locally using npm.

```bash
# install locally (recommended)
npm install dotenv --save
```

--------------------------------

### Install finalhandler

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/finalhandler/README.md

Use npm to install the package locally.

```sh
$ npm install finalhandler
```

--------------------------------

### Initialize Supabase Client

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/@supabase/supabase-js/README.md

Import the createClient function and initialize the connection using your project URL and public key.

```js
import { createClient } from '@supabase/supabase-js'

// Create a single supabase client for interacting with your database
const supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key')
```

--------------------------------

### Using es5-ext Shims

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/es5-ext/README.md

Examples of how to implement ES6 features globally or import them as standalone modules.

```APIDOC
## Implementing ES6 Features Globally

### Description
Forces an ES6 feature to be implemented on the native object if it does not already exist.

### Usage
```javascript
require("es5-ext/array/from/implement");
Array.from("foo"); // ['f', 'o', 'o']
```

## Importing Standalone Shims

### Description
Accesses the shim directly without modifying native objects. This will use the native implementation if available, falling back to the shim otherwise.

### Usage
```javascript
var aFrom = require("es5-ext/array/from");
aFrom("foo"); // ['f', 'o', 'o']
```

## Forcing Shim Usage

### Description
Uses the shim implementation unconditionally, even if a native implementation exists.

### Usage
```javascript
var aFrom = require("es5-ext/array/from/shim");
aFrom("foo"); // ['f', 'o', 'o']
```
```

--------------------------------

### Run server locally

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32_Stream_Robot3/README.md

Command to initiate the server for local development after updating environment variables.

```bash
node server 0.0.0.0
```

--------------------------------

### Initialize via ESM Module

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/@supabase/supabase-js/README.md

Import the client directly in browser modules using the ESM build.

```html
<script type="module">
  import { createClient } from 'https://cdn.jsdelivr.net/npm/@supabase/supabase-js/+esm'
  const supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key')

  console.log('Supabase Instance: ', supabase)
  // ...
</script>
```

--------------------------------

### Install range-parser

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/range-parser/README.md

Use npm to install the package in your Node.js project.

```sh
$ npm install range-parser
```

--------------------------------

### Install parseurl

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/parseurl/README.md

Use npm to install the package in your Node.js project.

```sh
$ npm install parseurl
```

--------------------------------

### Install body-parser

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/body-parser/README.md

Use npm to install the body-parser package in your project.

```sh
$ npm install body-parser
```

--------------------------------

### Initialize WebSocket Client and Handle Events

Source: https://github.com/williamsokol/esp32robots/blob/main/NodeJS-Site-Server/demo.html

Sets up the WebSocket connection, handles incoming image data, and manages connection lifecycle events.

```javascript
body { text-align: center; min-width: 500px; } // log function log = function(data){ $("div#terminal").prepend("</br>" +data); console.log(data); }; var ws; var wsinterval; function sendInputData() { var inputs = joy.GetX()+","+joy.GetY(); console.log(inputs); ws.send(inputs); } $(document).ready(function () { $("div#message_details").hide() $("#open").click(function(evt) { evt.preventDefault(); let uri = $("#domain").val(); let ws = new Websocket(`${uri}`) const img = document.querySelector('img'); let urlObject; // Handle incoming websocket message callback ws.onmessage = async function(evt) { // log("Message Received: " + evt.data) // $("#slider").val() = evt.data; const arrayBuffer = evt.data; //console.log(evt); a = await arrayBuffer.arrayBuffer() //console.log(arrayBuffer); if(urlObject){ URL.revokeObjectURL(urlObject); } urlObject = URL.createObjectURL(arrayBuffer); img.src = urlObject; }; // Close Websocket callback ws.onclose = function(evt) { log("**Connection Closed**"); alert("Connection close"); $("#uri").css("background", "#ff0000"); clearInterval(wsinterval); }; // Open Websocket callback ws.onopen = function(evt) { $("#uri").css("background", "#00ff00"); $("div#message_details").show(); log("**Connection Opened**"); wsinterval = setInterval(function(){ sendInputData(); }, 50); }; }); // Send websocket message function // $("#send").click(function(evt) { // log("Sending Message: "+$("#message").val()); // ws.send($("#message").val()); // }); // $("#slider").on('input' ,function(evt) { // log("Sending Message: "+$("#slider").val()); // //console.log("test"); // ws.send($("#slider").val()); // }); });
```

--------------------------------

### Install WebSocket type definitions

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32_Stream_Robot3_littlefire/NodeServer/node_modules/@types/websocket/README.md

Use this command to add the type definitions to your project dependencies.

```bash
npm install --save @types/websocket
```

--------------------------------

### Create a simple WebSocket server

Source: https://github.com/williamsokol/esp32robots/blob/main/NodeJS-CommandStream-Server/node_modules/ws/README.md

Initializes a standalone WebSocket server on a specified port.

```js
import { WebSocketServer } from 'ws';

const wss = new WebSocketServer({ port: 8080 });

wss.on('connection', function connection(ws) {
  ws.on('message', function message(data) {
    console.log('received: %s', data);
  });

  ws.send('something');
});
```

--------------------------------

### Define environment variables

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/dotenv/README.md

Create a .env file in the project root to store configuration keys.

```dosini
S3_BUCKET="YOURS3BUCKET"
SECRET_KEY="YOURSECRETKEYGOESHERE"
```

--------------------------------

### Install es6-iterator via npm

Source: https://github.com/williamsokol/esp32robots/blob/main/WifiSystems/GlobalWifiwebsocketIO/NodeServer/node_modules/es6-iterator/README.md

Command to install the package using npm.

```bash
$ npm install es6-iterator
```

--------------------------------

### Serve static files using Express

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32_Stream_Robot3/NodeServer/node_modules/serve-static/README.md

Demonstrates basic integration with the Express framework.

```js
var express = require('express')
var serveStatic = require('serve-static')

var app = express()

app.use(serveStatic('public/ftp', { index: ['default.html', 'default.htm'] }))
app.listen(3000)
```

--------------------------------

### Install vary package

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/vary/README.md

Command to install the vary module via npm.

```sh
$ npm install vary
```

--------------------------------

### Always 404 Example

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/finalhandler/README.md

Create a server that returns a 404 response for every request.

```js
var finalhandler = require('finalhandler')
var http = require('http')

var server = http.createServer(function (req, res) {
  var done = finalhandler(req, res)
  done()
})

server.listen(3000)
```

--------------------------------

### Create a WebSocket Server

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/websocket/README.md

Sets up a basic HTTP server and attaches a WebSocket server to it, with origin validation and message handling.

```javascript
#!/usr/bin/env node
var WebSocketServer = require('websocket').server;
var http = require('http');

var server = http.createServer(function(request, response) {
    console.log((new Date()) + ' Received request for ' + request.url);
    response.writeHead(404);
    response.end();
});
server.listen(8080, function() {
    console.log((new Date()) + ' Server is listening on port 8080');
});

wsServer = new WebSocketServer({
    httpServer: server,
    // You should not use autoAcceptConnections for production
    // applications, as it defeats all standard cross-origin protection
    // facilities built into the protocol and the browser.  You should
    // *always* verify the connection's origin and decide whether or not
    // to accept it.
    autoAcceptConnections: false
});

function originIsAllowed(origin) {
  // put logic here to detect whether the specified origin is allowed.
  return true;
}

wsServer.on('request', function(request) {
    if (!originIsAllowed(request.origin)) {
      // Make sure we only accept requests from an allowed origin
      request.reject();
      console.log((new Date()) + ' Connection from origin ' + request.origin + ' rejected.');
      return;
    }
    
    var connection = request.accept('echo-protocol', request.origin);
    console.log((new Date()) + ' Connection accepted.');
    connection.on('message', function(message) {
        if (message.type === 'utf8') {
            console.log('Received Message: ' + message.utf8Data);
            connection.sendUTF(message.utf8Data);
        }
        else if (message.type === 'binary') {
            console.log('Received Binary Message of ' + message.binaryData.length + ' bytes');
            connection.sendBytes(message.binaryData);
        }
    });
    connection.on('close', function(reasonCode, description) {
        console.log((new Date()) + ' Peer ' + connection.remoteAddress + ' disconnected.');
    });
});
```

--------------------------------

### Install forwarded module

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/forwarded/README.md

Use npm to install the package locally in your project.

```sh
$ npm install forwarded
```

--------------------------------

### Create and Subscribe to a Channel

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/@supabase/realtime-js/README.md

Initialize the RealtimeClient and subscribe to a channel to handle connection status updates.

```js
import { RealtimeClient } from '@supabase/realtime-js'

const client = new RealtimeClient(REALTIME_URL, {
  params: {
    apikey: API_KEY,
    eventsPerSecond: 10,
  },
})

const channel = client.channel('test-channel', {})

channel.subscribe((status, err) => {
  if (status === 'SUBSCRIBED') {
    console.log('Connected!')
  }

  if (status === 'CHANNEL_ERROR') {
    console.log(`There was an error subscribing to channel: ${err.message}`)
  }

  if (status === 'TIMED_OUT') {
    console.log('Realtime server did not respond in time.')
  }

  if (status === 'CLOSED') {
    console.log('Realtime channel was unexpectedly closed.')
  }
})
```

--------------------------------

### Install etag package

Source: https://github.com/williamsokol/esp32robots/blob/main/RobotBuilds/Esp32-Stream-Robot2/NodeServer/node_modules/etag/README.md

Use npm to install the etag module into your project.

```sh
$ npm install etag
```
Tokens:
Raw