Initial commit of configurator

.vitepress/config.mts

@@ -198,6 +198,17 @@ export default defineConfig({
                 text: 'Development Environment'
               },
             ]
+          },
+          { 
+            text: 'Configurator',
+            link: '/configurator/',
+            collapsed: true,
+            items: [
+              {
+                text: 'Development Environment',
+                link: '/configurator/development_environment/'
+              }
+            ]
           }
         ],
     },

configurator/development_environment/index.md

@@ -0,0 +1,32 @@
+# Development Environment Setup
+
+## Clone the source code from GitHub
+
+Use SourceTree or other application to clone the code from GitHub to a local directory.
+
+## Setup Virtual Environment
+
+Change to the new source code directory:
+
+`cd /path/to/source/`
+
+Create the virtual environment:
+
+`python3 -m venv ./.venv`
+
+::: info
+Ensure that the .venv folder is not added to source control.
+:::
+
+Use PIP to download and install the prerequisites:
+
+`./.venv/bin/pip install --no-cache-dir -r requirements.txt`
+
+## Development Testing
+
+Launch the code without building a container to test within:
+
+`./.venv/bin/python main.py`
+
+
+## Creating a Container

configurator/index.md

@@ -0,0 +1,7 @@
+# FireFly Configurator
+
+## Purpose
+FireFly Configurator is an easy-to-use Web UI designed to allow full local configuration of the FireFly components.  Data is stored within a database and hosted in Docker.
+
+::: info
+FireFly Configurator is an optional component, since configuration files can be manually adjusted and pushed to the Controller and Clients.  However, using a single web-based UI significantly reduces the effort requried to configure, maintain, and move configurations amongst devices.