mirror of
https://github.com/TryGhost/Ghost.git
synced 2025-01-27 22:49:56 -05:00
📖 Update README installation instructions (#8175)
- add contributing workflow link already - i would suggest we merge this PR if the workflow guide was reviewed
This commit is contained in:
parent
c9500b11ea
commit
76fd1264a8
2 changed files with 21 additions and 15 deletions
33
README.md
33
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
|
# 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.
|
||||||
|
<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
|
```bash
|
||||||
git clone [Ghost's repo URL or your Ghost Fork's URL]
|
grunt test-all
|
||||||
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
|
|
||||||
```
|
```
|
||||||
|
|
||||||
To run tests
|
Run client tests
|
||||||
```bash
|
```bash
|
||||||
|
cd core/client
|
||||||
ember test
|
ember test
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
Read more about the [development workflows](https://github.com/TryGhost/Ghost/wiki/Working-with-Ghost).
|
||||||
|
|
||||||
# Deploying 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>
|
<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>
|
||||||
|
|
|
@ -19,7 +19,8 @@
|
||||||
"main": "./core/index",
|
"main": "./core/index",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"start": "node index",
|
"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": {
|
"engines": {
|
||||||
"node": "^4.2.0 || ^6.5.0"
|
"node": "^4.2.0 || ^6.5.0"
|
||||||
|
|
Loading…
Add table
Reference in a new issue