We're going to start from the very beginning by installing the software necessary to develop with Apostrophe. In the next tutorial, we'll set up an empty Apostrophe site.
These instructions are for MacOS X, which most developers use to test code that will eventually deploy to Linux. Also see this lovely HOWTO for Windows contributed by Michael Brown.
This will get you set up on a Mac running OSX 10.9 or better.
We're going to install the following software:
XCode is provided free of charge by Apple. Install it via the Mac App Store.
You will also need the Xcode Command Line Tools, which can be installed by going to Xcode -> Preferences ... -> Downloads.
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.
Homebrew is a convenient software manager that makes it easier to keep track of and update your software packages.
Installing Homebrew is easy:
ruby -e "$(curl -fsSL https://raw.github.com/Homebrew/homebrew/go/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 (if you haven't used one before, you'll get TextEdit):
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
MongoDB is the database that Apostrophe uses. You can install it with homebrew:
brew install mongo
During the mongo install, it will print out instructions for starting mongo on login (recommended for developers), which should look like this:
==> Caveats To have launchd start mongodb at login: ln -sfv /usr/local/opt/mongodb/*.plist ~/Library/LaunchAgents Then to load mongodb now: launchctl load ~/Library/LaunchAgents/homebrew.mxcl.mongodb.plist Or, if you don't want/need launchctl, you can just run: mongod
Run those, open a new tab and try:
It should start an interactive mongo prompt. ctrl+c to exit.
brew install imagemagick
Now you have the
identify command line tools, which Apostrophe uses to scale and crop images.
Now that you have your environment configured it's time to create our first Apostrophe project.