Mobify DevCenter

DocumentationAPI & SDK ReferenceHow-To GuidesMobify University

Installation

Important: Our installation instructions have been updated to reflect many new technologies released starting in November 2018. If you need to install a project that was generated before November 2018, you can still access the old Quick Start guide.

Supported operating systems

The Mobify Platform supports the following operating systems:

  • macOS 10.13 or greater
  • Windows 7 or greater
  • Ubuntu Linux 18.x or greater

We recommend the following for your hardware setup, at a minimum:

  • 16 GB RAM
  • Solid-state drive (SSD)
  • 2 or more CPU cores

Installing required software

Before you start development, you’ll need to install the following software on any computers you plan to use for development:

Start by installing Node 10.17.0:

  • Download our recommended version of Node, version 10.17.0:

    (These links will directly download the compatible .msi file for your machine.)

  • Run the installer and complete the setup instructions after downloading.

  • When prompted by the installer, accept the default option to also install the Node.js runtime and Node Package Manager (npm), and to add the runtime to your path. This will give you npm version 6.11.3.

  • Open your Command Prompt and run node -v.

  • Confirm that Node 10.17.0 has been installed successfully.

If you already have a newer version of Node installed, you should be able to use it instead of version 10.17.0. However, with server-side rendered PWAs, you must make sure that your code is compatible with Node 10.17.0. Also, you should test your work extensively in a staging environment before publishing anything into production because the production Lambda will be running the most recent LTS version of Node 10.

For best results, we do not recommend using Corey Butler's Node Version Manager (nvm) for Windows. In our testing, installations are more often successful by installing Node directly without using nvm.

Next, install Node Package Manager (npm) 6.11.3, which is required for developing with the Mobify Platform.

  • Open your Command Prompt and run npm install -g npm@6.11.3
  • Run npm -v to confirm that npm 6.11.3 has been installed successfully

If you don't have these programs already, you will also need to install:

Start by installing Node 10.17.0:

  • Download our recommended version of Node, version 10.17.0. (This link will directly download the compatible .pkg file.)
  • Run the installer and complete the setup instructions after downloading.
  • Open your terminal and run node -v
  • Confirm that Node 10.17.0 has been installed successfully.

If you already have a newer version of Node installed, you should be able to use it instead of version 10.17.0. However, with server-side rendered PWAs, you must make sure that your code is compatible with Node 10.17.0. Also, you should test your work extensively in a staging environment before publishing anything into production because the production Lambda will be running the most recent LTS version of Node 10.

If you're using Node Version Manager (nvm) to install Node, then npm 6.11.3 will automatically be installed for you.

If you don't have these programs already, you will also need to install:

Start by installing Node 10.17.0:

  • Go to this link to download Node 10.17.0
  • Download the right binary for your machine. (For example, if you have a 64-bit Intel machine, you would choose the x64 file.)
  • Extract the binaries and complete the setup instructions after downloading.
  • Open your terminal and run node -v
  • Confirm that Node 10.17.0 has been installed successfully.

If you already have a newer version of Node installed, you should be able to use it instead of version 10.17.0. However, with server-side rendered PWAs, you must make sure that your code is compatible with Node 10.17.0. Also, you should test your work extensively in a staging environment before publishing anything into production because the production Lambda will be running the most recent LTS version of Node 10.

If you're using Node Version Manager (nvm) to install Node, then npm 6.11.3 will automatically be installed for you. This version will be enough for your Mobify project.

If you don't have these programs already, you will also need to install:

Finding your project files

Most of the time, your project files will already be generated for you, and you will need to ask someone from your team to give you access to them.

Now, let’s take a short tour of what’s inside. The most important directory in the project is packages. This is where you’ll spend most of your time in development. It contains all the code you’ll need to build a PWA, including multiple SDK packages from Mobify.

Installing dependencies

Now we need to download and install package dependencies using Node Package Manager (npm) by running the following command from your project directory:

cd <YOUR-PROJECT>
npm install --quiet

Note It might take a few minutes before you see any activity in the terminal, so don’t cancel the process until it finishes. Thanks for your patience!

Start your dev server

To start your local web server for local development, run the following commands:

cd packages/pwa
npm run ssr

Now that the development server is running, you can open the PWA in a browser:

Success! You should now see the home page for the project scaffold application in your browser. You can stop the development server at any time by using the keyboard shortcut Control-C.