Skip to content

Commit

Permalink
📖 Update README installation instructions (#8175)
Browse files Browse the repository at this point in the history
- add contributing workflow link already
- i would suggest we merge this PR if the workflow guide was reviewed
  • Loading branch information
kirrg001 authored and ErisDS committed Mar 23, 2017
1 parent c9500b1 commit 76fd126
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 16 deletions.
35 changes: 20 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

If you get stuck, come say hi over [on slack](https://slack.ghost.org)!
**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)!

Install and run Ghost.
<pre>
<b>git clone git@github.com:TryGhost/Ghost.git ghost</b>
Download the Ghost code base
<b>npm run init</b>
Short command for: npm install -g knex-migrator ember-cli grunt-cli && npm install && grunt init
<b>knex-migrator init</b>
Creates and initialises your database
<b>grunt dev</b>
Starts the express server and ember build
</pre>

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

<a href="https://ghost.org/pricing"><img src="https://cloud.githubusercontent.com/assets/120485/18662071/f30da886-7f18-11e6-90f2-42c0ade79fd1.png" alt="Ghost(Pro)" /></a>
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit 76fd126

Please sign in to comment.