generator-landmark
v0.1.45
Published
A LandmarkJS Project Generator for Yeoman
Downloads
14
Readme
Landmark Generator
A Yeoman generator for LandmarkJS, the model-driven cms for node.js built on Express and MongoDB.
yo landmark
will scaffold a new LandmarkJS project for you, and offer to set up blog, gallery, and enquiry (contact form) models + views.
Getting Started
First up, you'll need Node.js >= 0.10.x and MongoDB >= 2.4.x installed. If you don't have them, follow the Dependencies instructions below.
Then, install the Landmark generator:
$ npm install -g generator-landmark
If you see errors, check the problems section below.
With the generator installed, create an empty directory for your new LandmarkJS Project, and run yo landmark
in it:
$ mkdir myproject
$ cd myproject
$ yo landmark
The generator will ask you a few questions about which features to include, then prompt you for Cloudinary and Mandrill account details.
These accounts are optional, but Cloudinary is used to host the images for the blog and gallery templates. You can get a free account for each at:
- Cloudinary - Image serving and management in the cloud
- Mandrill - Transactional email service by Mailchimp
What next?
When you've got your new project, check out the LandmarkJS Documentation to learn more about how to get started with LandmarkJS.
Problems?
ERR! Please try running this command again as root/Administrator.
When running npm install -g generator-landmark
, you may get an EACCES error asking you to run the command again as root/Administrator. This indicates that there is a permissions issue.
On your development system you can change directory ownership to the current $USER so you do not have to run sudo
while installing untrusted code:
sudo chown -R $USER /usr/local
# Other directories may be required depending on your O/S
sudo chown -R $USER /usr/lib/node_modules/
For a production/shared environment you may wish to re-run the npm
command with the sudo
prefix:
sudo npm install -g generator-landmark
For more information, see the "What, no sudo?" of the Intro to npm by Isaac Schulueter.
What do you mean it couldn't find my Database?
By default, LandmarkJS will look for a MongoDB server running on localhost
on the default port, and connect to it. If you're getting errors related to the MongoDB connection, make sure your MongoDB server is running.
If you haven't installed MongoDB yet, follow the instructions below.
To connect to a server other than localhost
, add a MONGO_URI
setting to the .env
file in your Landmark project directory:
MONGO_URI=mongodb://your-server/database-name
Dependencies
Install Node.js
Download and install the node.js binaries for your platform from the Node.js download page.
Install MongoDB
If you're on a mac, the easiest way to install MongoDB is to use the homebrew package manager for OS X. To install it, run this in your terminal:
ruby -e "$(curl -fsSL https://raw.github.com/Homebrew/homebrew/go/install)"
With Homebrew installed, run this in your terminal to download and install MongoDB:
brew mongo
For other platforms, see the MongoDB installation guides.