# Install using the installer. curl https://install.grow.io | bash # Install using pip. pip install grow
npm) to successfully develop these projects on your machine in addition to Grow.
# Install pip. sudo easy_install pip # Install nvm (used to install node) # See instructions: https://github.com/nvm-sh/nvm#install-script # Install Homebrew (used to install Yarn) # See instructions: https://brew.sh/ # Install Yarn. brew install yarn
Note: some Node programs (e.g. certain versions of
node-sass) may require Xcode and the command line tools to compile. Install Xcode (using App Store) and then follow the
xcode-select instructions here.
This should cover most scenarios for installing and using Grow.
Using the development server
Grow comes with a built-in development server. The development server dynamically renders and builds pages when requested. This avoids the need to watch files for changes and allows you to iteratively develop without rebuilding your entire site.
You can start the server with the
grow run command:
When you start the development server, Grow checks for updates to the SDK, compiles translation catalogs, and runs any preprocessors configured in
The development server does not currently integrate with any other preprocessing systems, such as Gulp. You must execute those manually.
By default, the development server binds to
localhost to avoid accidentally providing anyone from accessing your development server. If you need to access the development server from other devices on your local network, use the
--port flags to explicitly set the host and port parameters, respectively.
grow run --host=0.0.0.0 --port=8080
The development server includes a basic web console that provides information about your site. Use the console to quickly audit your site's routes, collections, and translations.
Access the console by visiting
Install Grow from source using
pipenv – enabling you to run multiple versions of Grow simultaneously.
# Install pipenv (run this one time). brew install pipenv libyaml # Activate a shell, install and run Grow from within your project folder. pipenv install grow==1.0.0a10 pipenv run grow run
If your project has a
Pipfile, just run
pipenv install then
pipenv run grow run.
watchdog on macOS and Python 3.8
Certain configurations of macOS and xCode may run into issues installing the
watchdog dependency. The simplest way to resolve this is to use Python 3.7, which isn't impacted by the issue. Many systems will have Python 3.7 available, but newer systems may only have Python 3.8.
# Install Python 3.7.9 globally. brew install pyenv pyenv install 3.7.9 pyenv global 3.7.9 # Run from your Grow project directory. pipenv --rm pipenv install