Added build script for unix OSes

2 files changed, 143 insertions, 3 deletions

diff --git a/scripts/build-unix.sh b/scripts/build-unix.sh
new file mode 100755
index 0000000..ff1ce0f
--- /dev/null
+++ b/scripts/build-unix.sh
@@ -0,0 +1,142 @@
+#!/bin/bash
+
+# INTRO:
+# This file is used to build ferdium-server on both x64 and arm-based for macos and linux (not tested on arm for linux).
+# It also handles any corrupted node modules with the 'CLEAN' env var (set it to 'true' for cleaning)
+# It will install the system dependencies except for node and python (which are still verified)
+# I sometimes symlink my 'recipes' folder so that any changes that I need to do in it can also be committed and pushed independently
+# This file can live anywhere in your PATH
+
+set -e
+
+export CI=true
+
+# -----------------------------------------------------------------------------
+#                  Utility functions
+fail_with_docs() {
+  printf "\n*************** FAILING ***************\n"
+  echo "$1"
+  echo ""
+  echo "Please read the developer documentation in CONTRIBUTING.md"
+  exit 1
+}
+
+command_exists() {
+  type "$1" &>/dev/null 2>&1
+}
+
+# -----------------------------------------------------------------------------
+#                  Checking the developer environment
+# Check for installed programmes
+command_exists node || fail_with_docs "Node is not installed"
+command_exists python || fail_with_docs "python is not installed"
+
+# Check node version
+EXPECTED_NODE_VERSION=$(cat .nvmrc)
+ACTUAL_NODE_VERSION=$(node -v)
+if [ "v$EXPECTED_NODE_VERSION" != "$ACTUAL_NODE_VERSION" ]; then
+  fail_with_docs "You are not running the expected version of node!
+    expected: [v$EXPECTED_NODE_VERSION]
+    actual  : [$ACTUAL_NODE_VERSION]"
+fi
+
+# Check if the 'recipes' folder is present either as a git submodule or a symbolic link
+if ! [ -f "recipes/package.json" ]; then
+  fail_with_docs "'recipes' folder is missing or submodule has not been checked out"
+fi
+
+# This log statement is only to remind me which 'recipes' folder I am using (symlink or git submodule)
+if [[ -L recipes ]]; then
+  printf "\n*************** CONTINUING for 'recipes' symlinked ***************\n"
+else
+  printf "\n*************** CONTINUING for 'recipes' submodule ***************\n"
+fi
+
+# -----------------------------------------------------------------------------
+# If you are moving to a new version of node or any other system dependency, then cleaning is recommended
+# so that there's no irregular results due to cached modules
+if [ "$CLEAN" != "true" ]; then
+  printf "\n*************** SKIPPING Cleaning ***************\n"
+else
+  printf "\n*************** Cleaning!!!!!! ***************\n"
+
+  if [[ -s 'pnpm-lock.yaml' ]]; then
+    pnpm store prune || true # in case the pnpm executable itself is not present
+    rm -rf ~/.pnpm-store ~/.pnpm-state
+  fi
+
+  npm cache clean --force
+  rm -rf ~/.npm ~/.node-gyp ~/.asdf/installs/nodejs/*/.npm/
+
+  git -C recipes clean -fxd # Clean recipes folder/submodule
+  git clean -fxd            # Note: This will blast away the 'recipes' folder if you have symlinked it
+fi
+
+# -----------------------------------------------------------------------------
+# Ensure that the system dependencies are at the correct version - fail if not
+# Check python version
+EXPECTED_PYTHON_VERSION="3.10.4"
+ACTUAL_PYTHON_VERSION=$(python --version | sed -e "s/Python //")
+if [[ "$ACTUAL_PYTHON_VERSION" != "$EXPECTED_PYTHON_VERSION" ]]; then
+  fail_with_docs "You are not running the expected version of Python!
+    expected: [$EXPECTED_PYTHON_VERSION]
+    actual  : [$ACTUAL_PYTHON_VERSION]"
+fi
+
+# -----------------------------------------------------------------------------
+# Ensure that the system dependencies are at the correct version - recover if not
+# If 'asdf' is installed, reshim for new nodejs if necessary
+command_exists asdf && asdf reshim nodejs
+
+# Ensure that the system dependencies are at the correct version
+# Check npm version
+EXPECTED_NPM_VERSION=$(node -p 'require("./package.json").engines.npm')
+ACTUAL_NPM_VERSION=$(npm --version)
+if [[ "$ACTUAL_NPM_VERSION" != "$EXPECTED_NPM_VERSION" ]]; then
+  npm i -gf npm@$EXPECTED_NPM_VERSION
+fi
+
+# Check pnpm version
+EXPECTED_PNPM_VERSION=$(node -p 'require("./recipes/package.json").engines.pnpm')
+ACTUAL_PNPM_VERSION=$(pnpm --version || true) # in case the pnpm executable itself is not present
+if [[ "$ACTUAL_PNPM_VERSION" != "$EXPECTED_PNPM_VERSION" ]]; then
+  npm i -gf pnpm@$EXPECTED_PNPM_VERSION
+fi
+
+# If 'asdf' is installed, reshim for new nodejs if necessary
+command_exists asdf && asdf reshim nodejs
+
+# -----------------------------------------------------------------------------
+# This is useful if we move from 'npm' to 'pnpm' for the main repo as well
+if [[ -s 'pnpm-lock.yaml' ]]; then
+  BASE_CMD=pnpm
+else
+  BASE_CMD=npm
+fi
+
+ENV_FILE=".env"
+if [[ ! -s $ENV_FILE ]]; then
+  APP_KEY=`cat /dev/urandom | LC_ALL=C tr -dc "[:alnum:]" | fold -w ${1:-32} | head -n 1`
+  # SAVE APP_KEY TO .env FILE
+  sed "s/APP_KEY\=/APP_KEY=$APP_KEY/" .env.example > $ENV_FILE
+fi
+
+mkdir -p data
+
+# -----------------------------------------------------------------------------
+printf "\n*************** Building recipes ***************\n"
+# Note: 'recipes' is already using only pnpm - can switch to $BASE_CMD AFTER both repos are using pnpm
+pushd recipes
+pnpm i
+pnpm package
+popd
+
+# Now the meat.....
+$BASE_CMD i
+node ace migration:refresh
+
+# -----------------------------------------------------------------------------
+printf "\n*************** Building app ***************\n"
+$BASE_CMD start --dev
+
+printf "\n*************** App successfully stopped! ***************\n"
diff --git a/scripts/build-windows.ps1 b/scripts/build-windows.ps1
index e932da9..81187c6 100644
--- a/scripts/build-windows.ps1
+++ b/scripts/build-windows.ps1
@@ -136,12 +136,10 @@ if ($ACTUAL_PNPM_VERSION -ne $EXPECTED_PNPM_VERSION) {
 if ((Test-Path -Path ".\pnpm-lock.yaml") -and (Get-Command -ErrorAction Ignore -Type Application pnpm))
 {
   $BASE_CMD="pnpm"
-  $env:EXEC_CMD="pnpm dlx"
 }
 else
 {
   $BASE_CMD="npm"
-  $env:EXEC_CMD="npx"
 }
 
 $ENV_FILE = ".env"
@@ -149,7 +147,7 @@ if (-not (Test-Path -Path $ENV_FILE)) {
   Copy-Item .env.example -Destination $ENV_FILE
   $APP_KEY = ("!@#$%^&*0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz".tochararray() | sort {Get-Random})[0..32] -join ''
   # SAVE APP_KEY TO .env FILE
-  (Get-Content $ENV_FILE -Raw) -replace 'APP_KEY', "APP_KEY=$APP_KEY" |  Set-Content $ENV_FILE
+  (Get-Content $ENV_FILE -Raw) -replace 'APP_KEY=', "APP_KEY=$APP_KEY" | Set-Content $ENV_FILE
 }
 
 if (-not (Test-Path -Path "data")) {