Installation

Python 3.9 or higher and Node.js 18 or higher are required to use Morph.

Prerequisites

To use all features of Morph, the following environment is required.

If these setups are not completed, Morph’s CLI and framework may not function properly.

Python 3.9 - 3.12

For the Morph framework to work, Python 3.9 or higher, but less than 3.13 is required*.

To check your Python version, run the following command:

python --version

If Python 3.9 or higher is not installed, please follow the steps below to install it.

• Mac
• Windows
• Linux

Installation from the official website

• Download the macOS installer (.pkg file) from the official Python website and install it by double-clicking.

Installing Python and pyenv with Homebrew for package management

• Homebrew installation.
• Run brew install python in the terminal to install the latest Python.
• Run brew install pyenv in the terminal to install pyenv.
• Run pyenv install 3.11.11 in the terminal to install Python 3.11.11.

Node.js 18 or higher, npm 7 or higher

For the Morph framework to function, Node.js 18 or higher and npm 7 or higher are required.

To check your Node.js version, run the following command:

node --version

If Node.js 18 or higher is not installed, please follow the steps below to install it.

• Mac
• Windows
• Linux

Installation from the official website

• Download the macOS installer (.pkg file) from the official Node.js website and install it.

Installing Node.js and nodenv with Homebrew for package management

• Homebrew installation.
• Run brew install node in the terminal to install the latest Node.js.

Installing Node.js using nvm

• Refer to the nvm documentation to install nvm.

Docker

Docker is required to deploy the Morph framework in a cloud environment.

If Docker is not installed, please follow the steps below to install it.

• Mac
• Windows
• Linux

Installation from the official website

• Download the macOS installer (.dmg file) from the official Docker website and install it.

Installing Morph

1

Install morph using pip

Shell

pip install morph-data

2

Create a Morph Project

Use the morph new command to create a Morph project.

Shell

morph new morph-starter-app

3

Start the Morph Development Server

Use the morph serve command to start the Morph development server.

Shell

cd morph-starter-app
morph serve

4

Open the App in the Browser

Access localhost:8080 to open the app.

5

Build the App using SQL, Python, and MDX

Up to this point, you have started the basic development server. Let’s build the app using SQL, Python, and MDX!

Editor (VS Code) Setup

MDX files used in the Morph frontend can have syntax highlighting and code completion by installing the VSCode extension.

https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx