From 76fd1264a843f23ce24e7d5f83234ee5053f2eec Mon Sep 17 00:00:00 2001 From: Katharina Irrgang Date: Thu, 23 Mar 2017 17:02:21 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=96=20=20Update=20README=20installatio?= =?UTF-8?q?n=20instructions=20(#8175)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - add contributing workflow link already - i would suggest we merge this PR if the workflow guide was reviewed --- README.md | 33 +++++++++++++++++++-------------- package.json | 3 ++- 2 files changed, 21 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index de2582104f..0ea222d06c 100644 --- a/README.md +++ b/README.md @@ -19,30 +19,35 @@ The project is maintained by a non-profit organisation called the **Ghost Founda # Ghost 1.0-alpha Developer Install -**Please note:** These are the install instructions for Ghost 1.0-alpha, which is **not** stable. If you're looking for the latest release of Ghost, check out the [stable branch](https://github.com/TryGhost/Ghost/tree/stable) or the [latest release](https://github.com/TryGhost/Ghost/releases). +**Please note:** These are the install instructions for Ghost 1.0-alpha, which is **not** stable. If you're looking for the latest release of Ghost, check out the [stable branch](https://github.com/TryGhost/Ghost/tree/stable) or the [latest release](https://github.com/TryGhost/Ghost/releases). If you get stuck, come say hi over [on slack](https://slack.ghost.org)! -If you get stuck, come say hi over [on slack](https://slack.ghost.org)! +Install and run Ghost. +
+git clone git@github.com:TryGhost/Ghost.git ghost
+    Download the Ghost code base
+npm run init
+    Short command for: npm install -g knex-migrator ember-cli grunt-cli && npm install && grunt init
+knex-migrator init
+    Creates and initialises your database 
+grunt dev
+    Starts the express server and ember build 
+
+ +Run server tests ```bash -git clone [Ghost's repo URL or your Ghost Fork's URL] -npm install -g knex-migrator grunt -npm install -git submodule update --init -cd core/client -npm install -bower install -cd ../.. -grunt build -knex-migrator init -grunt dev +grunt test-all ``` -To run tests +Run client tests ```bash +cd core/client ember test ``` +Read more about the [development workflows](https://github.com/TryGhost/Ghost/wiki/Working-with-Ghost). + # Deploying Ghost Ghost(Pro) diff --git a/package.json b/package.json index c7bf1f4f29..6e1672a191 100644 --- a/package.json +++ b/package.json @@ -19,7 +19,8 @@ "main": "./core/index", "scripts": { "start": "node index", - "test": "grunt validate --verbose" + "test": "grunt validate --verbose", + "init": "npm install -g knex-migrator ember-cli grunt-cli && npm install && grunt init" }, "engines": { "node": "^4.2.0 || ^6.5.0"