Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
vintidui committed Apr 15, 2024
1 parent b7f757e commit 190af06
Showing 1 changed file with 20 additions and 56 deletions.
76 changes: 20 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,34 @@
# Morhpheus Node Setup

Morhpheus Node Setup
## Prerequisites

- Node.js: https://nodejs.org/en/download

## Running development environment

Windows OS Systems
1. Install dependencies
In the root directory of the Morpheus client local repository, type the following command: `npm install`

Prerequisites
2. Run the Morpheus client app
Then type the following command: `npm run start`

Node.js for Windows
Follow the instructions listed here for Node.js setup:
https://phoenixnap.com/kb/install-node-js-npm-on-windows
## Building executable app

Yarn for Windows
Follow the instructions listed here for Yarn Package Manager setup:
https://phoenixnap.com/kb/yarn-windows
1. Install dependencies
In the root directory of the Morpheus client local repository, type the following command: `npm install`

1. Create Project Directory
Open a Windows command prompt and create a project folder and put your command line at that directory

I.e. Presume the starting directory is: C:\projects
2. Build the Morpheus client app
Then type the following command: `npm run make`

mkdir c:\projects
3. Application runtime and testing
Upon successful build, find the Morpheus client app executable for your operating system in the following directory:

cd /d c:\projects

2. Morpheus client Workspace Setup
From a command line at the project directory (created in #1), type:
`<PATH_TO_LOCAL_MORPHEUS_CLIENT_REPO>/out`

git clone https://github.com/MorpheusAIs/Lite-Client.git
## Notes

3. Project Environment Setup
Set up the modules and components using the Yarn Package Manager
• Additional run, test, and build scripts are located in the `package.json` configuration file in the root directory of the Morpheus client repo

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


6. 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



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)
• 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.

0 comments on commit 190af06

Please sign in to comment.