start.sh

#!/usr/bin/env bash

# Copyright 2014 The Oppia Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS-IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

##########################################################################

# INSTRUCTIONS:
#
# This script starts up a development server running Oppia. It installs any
# missing third-party dependencies and starts up a local GAE development
# server.
#
# Run the script from the oppia root folder:
#
#   bash scripts/start.sh
#
# Note that the root folder MUST be named 'oppia'.

if [ -z "$BASH_VERSION" ]
then
  echo ""
  echo "  Please run me using bash: "
  echo ""
  echo "     bash $0"
  echo ""
  exit 1
fi

if [ -e "/etc/is_vagrant_vm" ]
then
  source $(dirname $0)/vagrant_lock.sh || exit 1
fi

set -e
source $(dirname $0)/setup.sh || exit 1
source $(dirname $0)/setup_gae.sh || exit 1
set -- "${remaining_params[@]}"

# Install third party dependencies.
bash scripts/install_third_party.sh

# Check that there isn't a server already running.
if ( nc -vz localhost 8181 >/dev/null 2>&1 ); then
  echo ""
  echo "  WARNING"
  echo "  Could not start new server. There is already an existing server"
  echo "  running at port 8181."
  echo ""
  exit 1
fi

# Argument passed to dev_appserver.py to indicate whether or not to
# clear the datastore.
CLEAR_DATASTORE_ARG="--clear_datastore=true"
ENABLE_CONSOLE_ARG=""

# Argument passed to feconf.py to help choose production templates folder.
FORCE_PROD_MODE=False
START_BROWSER=True
for arg in "$@"; do
  if [ "$arg" == "--save_datastore" ]; then
    CLEAR_DATASTORE_ARG=""
  fi
  if [ "$arg" == "--enable_console" ]; then
    ENABLE_CONSOLE_ARG="--enable_console=true"
  fi
  # Used to emulate running Oppia in a production environment.
  if [ "$arg" == "--prod_env" ]; then
    FORCE_PROD_MODE=True
  fi
  if [ "$arg" == "--no-browser" ]; then
    START_BROWSER=False
  fi
done

if [[ "$FORCE_PROD_MODE" == "True" ]]; then
  constants_env_variable="\"DEV_MODE\": false"
  sed -i.bak -e s/"\"DEV_MODE\": .*"/"$constants_env_variable"/ assets/constants.js
  $PYTHON_CMD scripts/build.py --prod_env --enable_watcher
  APP_YAML_FILEPATH="app.yaml"
else
  constants_env_variable="\"DEV_MODE\": true"
  sed -i.bak -e s/"\"DEV_MODE\": .*"/"$constants_env_variable"/ assets/constants.js
  $PYTHON_CMD scripts/build.py --enable_watcher
  APP_YAML_FILEPATH="app_dev.yaml"
fi

# Delete the modified feconf.py file(-i.bak)
rm assets/constants.js.bak

# Set up a local dev instance.
# TODO(sll): do this in a new shell.
# To turn emailing on, add the option '--enable_sendmail=yes' and change the relevant
# settings in feconf.py. Be careful with this -- you do not want to spam people
# accidentally!

if ! [[ "$FORCE_PROD_MODE" == "True" ]]; then
  ($NODE_PATH/bin/node $NODE_MODULE_DIR/gulp/bin/gulp.js watch)&
  # In prod mode webpack is launched through scripts/build.py
  echo Compiling webpack...
  $NODE_MODULE_DIR/webpack/bin/webpack.js --config webpack.dev.config.ts
  ($NODE_MODULE_DIR/webpack/bin/webpack.js --config webpack.dev.config.ts --watch)&
fi
echo Starting GAE development server
(python $GOOGLE_APP_ENGINE_HOME/dev_appserver.py $CLEAR_DATASTORE_ARG $ENABLE_CONSOLE_ARG --admin_host 0.0.0.0 --admin_port 8000 --host 0.0.0.0 --port 8181 --skip_sdk_update_check true $APP_YAML_FILEPATH)&

# Wait for the servers to come up.
while ! nc -vz localhost 8181 >/dev/null 2>&1; do sleep 1; done

# Launch a browser window.
if [ ${OS} == "Linux" ] && [ "$START_BROWSER" == "True" ]; then
  detect_virtualbox="$(ls -1 /dev/disk/by-id/)"
  if [[ $detect_virtualbox = *"VBOX"* ]]; then
    echo ""
    echo "  INFORMATION"
    echo "  Setting up a local development server. You can access this server"
    echo "  by navigating to localhost:8181 in a browser window."
    echo ""
  else
    echo ""
    echo "  INFORMATION"
    echo "  Setting up a local development server at localhost:8181. Opening a"
    echo "  default browser window pointing to this server."
    echo ""
    (sleep 5; xdg-open http://localhost:8181/ )&
  fi
elif [ ${OS} == "Darwin" ] && [ "$START_BROWSER" == "True" ]; then
  echo ""
  echo "  INFORMATION"
  echo "  Setting up a local development server at localhost:8181. Opening a"
  echo "  default browser window pointing to this server."
  echo ""
  (sleep 5; open http://localhost:8181/ )&
else
  echo ""
  echo "  INFORMATION"
  echo "  Setting up a local development server. You can access this server"
  echo "  by navigating to localhost:8181 in a browser window."
  echo ""
fi

echo Done!

# Function for waiting for the servers to go down.
function cleanup {
  echo ""
  echo "  INFORMATION"
  echo "  Cleaning up the servers."
  echo ""
  while ( nc -vz localhost 8181 >/dev/null 2>&1 ); do sleep 1; done
}

# Runs cleanup function on exit.
trap cleanup Exit

wait