Let's start from the very beginning by installing the software necessary to develop with Apostrophe. After that, we'll set up an empty Apostrophe site.
First we'll install the following software:
XCode (required for all compilation on Macs)
Homebrew (for easy installing)
Node & NPM
Optional: Imagemagick (for fast image manipulation with animated GIF support)
Launch the "Terminal" app. From this point on, anything
formatted like this is meant to be run at the terminal prompt. Basic familiarity with the terminal is very helpful for node and Apostrophe development.
You will also need the Xcode Command Line Tools, which can be installed by going to Xcode -> Preferences ... -> Downloads. This installs the XCode command line tools directly from Apple. You do not have to install the full XCode user interface.
Homebrew is a convenient software manager that makes it easier to keep track of and update your software packages.
Install Homebrew by copying and pasting this one-line command to the terminal:
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
One command is all it takes:
brew install node
The terminal prompt finds commands in folders listed in an environment variable called PATH. We'll need to add node's directory to our $PATH in order for it to work its magic.
Create a plaintext file called
.profile in your home directory if you don't already have one and open it with your text editor (which will default to TextEdit on a Mac, which is fine):
touch ~/.profile && open ~/.profile
In this new file, add these two lines:
export NODE_PATH="/usr/local/lib/node"export PATH="/usr/local/share/npm/bin:$PATH"
You should verify that this worked by opening a new Terminal tab and running:
It should echo the current PATH setting as a set of colon-separated values, beginning with your additions.
NPM may or may not have been installed with Node. Try:
If you get a "not found" error, run this:
curl -L https://npmjs.org/install.sh | sh
You'll need git to manage your source code. Macs come with it, but we suggest you get the latest via Homebrew:
brew install git
Apostrophe uses MongoDB as its database. You can install it with Homebrew. In addition, you can configure
brew services to launch it automatically for you, so you don't have to fuss with restarting it manually. First you need to install the "tap" for Mongo DB:
brew tap mongodb/brew
Then you can install MongoDB:
brew install mongodb-community
After it is installed, start the MongoDB service:
brew services start mongodb-community
Now open a new terminal window and try:
It should start an interactive mongo prompt. ctrl+c to exit.
"Hey, I got a connection failed error!" Make sure you ran
brew services start mongodb-community.
brew install imagemagick
Now you have the
identify command line tools, which Apostrophe uses to scale and crop images quickly, with animated GIF support. If you skip this step, Apostrophe can still handle image uploads more slowly, thanks to Jimp.
Now your environment is configured it's time to create our first Apostrophe project.