Mtt dev

Guides/Application_Development_Release_Workflow_Process.md

@@ -0,0 +1,36 @@
+                Application Development & Release Workflow Process (CI/CD)
+
+
+This document describes the CI/CD development and release process for the Lite-Client component of the Morpheus Ecosystem Project. It is an evolving document as enhancements are discovered and integrated.
+
+
+I. Development Cycle
+  A. Branch Creation
+     1. Developers update or create their branches (e.g., `DEV1`, `DEV2`, ..., `DEVX`) from the latest `INT` to incorporate recent changes.
+
+  B. Development and Testing
+     1. Development and local unit testing occur within these branches. Once a feature is complete, it's committed to the respective branch.
+
+II. CI/CD Workflow for Integration
+  A. Pull Request to INT
+    1. Developers push their changes to the `DEV` branch and create a pull request (PR) to the `INT` branch. 
+
+  B. Automated Testing and Version Increment
+    1. Automated tests run against the PR.
+    2. If tests pass, a minor version increment (e.g., `0.1.0` to `0.2.0`) is performed for new features or a patch version (e.g., `0.1.0` to `0.1.1`) for bug fixes, tagging the `INT` branch.
+
+III. User Acceptance Testing (UAT)
+  A. Execution of UAT on INT
+     1. The `INT` branch, now with the new version tag, undergoes UAT. Fixes are made in `DEV` branches as needed and go through the cycle again until UAT is passed.
+
+IV. Production Release
+  A. Preparation for Production
+     1. A PR is created from `INT` to `PROD` after successful UAT. The version tag from `INT` is proposed for the production release.
+
+  B. Final Review, Merge, and Production Tagging
+    1. The DevOps team conducts a final review. If approved, the PR is merged into `PROD`.
+    2. The merge commit in `PROD` is tagged with the version number from `INT` (e.g., `1.0.0`), clearly indicating the release version.
+
+V. Process Review and Optimization
+   A. Feedback is collected from all stakeholders post-release.
+   B. The process and tools are adjusted based on feedback to improve future cycles.

README.md

@@ -1,26 +1,68 @@
-## MORPHEUS NODE
 
-First, clone this repo.
+Morhpheus Node Setup
 
-Then, start yarn.
 
-`yarn`
 
-This will set up all node modules needed.
+Windows OS Systems
 
-If you want to test the app without building an executable:
+Prerequisites
 
-`yarn start`
+Node.js for Windows
+    Follow the instructions listed here for Node.js setup:
+•	https://phoenixnap.com/kb/install-node-js-npm-on-windows
 
-To build an executable to run on your current system's specs:
+Yarn for Windows 
+    Follow the instructions listed here for Yarn Package Manager setup:
+•	https://phoenixnap.com/kb/yarn-windows
 
-`yarn make`
+1. Create Project Directory
+Open a Windows command prompt and create a project folder and put your command line at that directory  
+I.e. C:\projects
 
-Other run, test, and build scripts can be found in package.json
+    mkdir c:\projects
+    cd /d c:\projects
 
-### Windows installer instructions
-[Google Doc](https://docs.google.com/document/d/1YjGAlTzglct8aNEqZAUeYD7SAmOETtmv/edit?usp=sharing&ouid=118042204753952761929&rtpof=true&sd=true)
+2. Morpheus client Workspace Setup
+    From a command line at the project directory (created in #1):
+
+        git clone https://github.com/MorpheusAIs/Lite-Client.git
+
+3. Project Environment Setup
+    Set up the modules and components using the Yarn Package Manager
+
+    Navigate to the command line of the Morpheus client local repository, then type the following command:
+
+    yarn
+
+    This will set up all node modules needed.
+
+4. Build the Morpheus Client App
+    From a command line at the root directory of the local Morpheus Client repo, build the client executable, type:
+
+    yarn make
+
+
+5. Application Runtime and Testing
+
+    Upon successful build, run the Morpheus client app by clicking the following executable or start from the command line:
+
+    <PATH-TO-LOCAL-MORPHEUS-CLIENT-REPO>\Lite-Client-main\out\morpheus-win32-x64.exe
 
-Please visit MOR.software to sign up as a developer to be rewarded for your merged contributions. Submit an MRC to get support for feature and improvement ideas.
 
-MOR.software is also the place to build, submit, deplloy, and manage all of your Smart Agents.
+
+NOTES
+•	Additional Run, Test, and Build scripts are located in the package.json configuration file in the root directory of the Morpheus client repo
+
+•	Please visit https://mor.software/ to sign up as a developer to be rewarded for your merged contributions. Submit an MRC to get support for feature and improvement ideas.
+
+•	https://mor.software/ is also the place to build, submit, deploy, and manage all of your Smart Agents.
+
+•	Be sure to complete these steps from an account with administrative access to the host machine
+
+•	The initial start of the application may take extended time to start due to the initial configuration and run of the application
+
+
+
+### Windows installer instructions (Doc format)
+[Google Doc](https://docs.google.com/document/d/1YjGAlTzglct8aNEqZAUeYD7SAmOETtmv/edit?usp=sharing&ouid=118042204753952761929&rtpof=true&sd=true)
+