Getting Started

Prerequisites to Building Comm.Land


  1. Make sure you have your SSH key configured with your GitHub
  2. Install Node (we recommend 16.15.0)
    1. It is strongly recommended that you use NVM to manage your Node versioning. Once installed, you can simply run the nvm use command before you start up your commland development server to ensure you’re on the desired version.
    2. Install NVM with: curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
  3. Yarn ≥ 1.22.0
    • Yarn will need to be installed globally for all the versions listed above.
    • npm install -g yarn

Clone commland-core


# in an appropriate dev directory:

git clone git@github.com:2600hz/commland-core.git commland/core \
  && cd commland/core \
  && yarn setup

The info for this document was taken directly from the commland-core repo, under the docs directory.

Add this script to your commland directory:

clone_commland.sh

#!/bin/bash
echo "Fetching Comm.land"
declare -a applications=("core" "cluster-manager" "sdk" "components" "navbar" "toolbar" "login" "userportal" "shipyard" "conferences-admin" "conferences" "screenpops-admin" "screenpops" "callcenter" "settings" "contacts" "webhooks" "phone-workspace" "faxes-workspace" "account-settings" "conferences-workspace" "chat-workspace" "external-websites")

for app in "${applications[@]}"
do
  git clone git@github.com:2600hz/commland-$app $app
done

build_commland.sh

#!/bin/bash
export NVM_DIR=$HOME/.nvm;
source $NVM_DIR/nvm.sh;

echo "Building comm.land applications"
declare -a applications=("core" "cluster-manager" "sdk" "components" "navbar" "toolbar" "login" "userportal" "shipyard" "conferences-admin" "conferences" "screenpops-admin" "screenpops" "callcenter" "settings" "contacts" "webhooks" "phone-workspace" "faxes-workspace" "account-settings" "conferences-workspace" "chat-workspace" "external-websites")
mkdir -p core/applications

for app in "${applications[@]}"
do
  echo "\n-----------------------\nBuilding commland-$app"
  cd $app
  git pull
  nvm use 
  yarn install && yarn run webpack
  mv dist ../core/applications/$app
  cd ..
done

echo "Installing commland-core dependencies"
cd core
nvm use 
yarn cache clean
yarn install

Start Comm.Land


Whenever you want to run commland, be sure you are in the commland/core directory first. Then, simply run:

nvm use
yarn start

Once the server has finished starting up, you can then navigate to the application in your browser via localhost:$PORT, with a default port of 9000.