Skip to content
This repository has been archived by the owner on Nov 24, 2021. It is now read-only.

Easier installation instructions #273

Merged
merged 1 commit into from May 16, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 4 additions & 10 deletions README.md
Expand Up @@ -8,22 +8,16 @@ A [Yeoman](http://yeoman.io) generator for [KeystoneJS](http://keystonejs.com),

First up, you'll need Node.js >= 0.12 and MongoDB >= 3.0 installed. If you don't have them, follow the **Dependencies** instructions below.

Then, install the Keystone generator:

````
$ npm install -g generator-keystone
````

If you see errors, check the [problems](#err-please-try-running-this-command-again-as-rootadministrator) section below.

With the generator installed, create an empty directory for your new KeystoneJS Project, and run `yo keystone` in it:
Create an empty directory for your new KeystoneJS Project, then run the generator:

````
$ mkdir myproject
$ cd myproject
$ yo keystone
$ npx -p yo -p generator-keystone yo keystone
````

_NOTE: If you see errors, check the [problems](#err-please-try-running-this-command-again-as-rootadministrator) section below._

The generator will ask you a few questions about which features to include, then prompt you for Cloudinary and Mailgun 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:
Expand Down