mirror of
https://github.com/TryGhost/Ghost.git
synced 2025-01-20 22:42:53 -05:00
Updated README.md and CONTRIBUTING.md
- improving installation / setup instructions and adding more detail about grunt tasks
This commit is contained in:
parent
5a9db4dc76
commit
f78ea7356f
2 changed files with 44 additions and 23 deletions
|
@ -18,9 +18,10 @@ If you think you've found a problem with Ghost, or you'd like to make a request
|
||||||
|
|
||||||
**Pre-requisites:**
|
**Pre-requisites:**
|
||||||
|
|
||||||
* node 0.10 or 0.11
|
* node > 0.10 and < 0.11.4
|
||||||
* ruby and the gems 'sass' and 'bourbon'
|
* ruby and the gems 'sass' and 'bourbon'
|
||||||
* if you want to build the docs, python and pygments
|
* for running functional tests: phantomjs 1.9.* and casperjs 1.1.* ([instructions](https://github.com/TryGhost/Ghost/wiki/Functional-testing-with-PhantomJS-and-CasperJS))
|
||||||
|
* for building docs:, python and pygments
|
||||||
|
|
||||||
|
|
||||||
## Key Branches & Tags
|
## Key Branches & Tags
|
||||||
|
@ -30,8 +31,7 @@ If you think you've found a problem with Ghost, or you'd like to make a request
|
||||||
- **[releases](https://github.com/TryGhost/Ghost/releases)** are used to contain stable tagged versions of Ghost.
|
- **[releases](https://github.com/TryGhost/Ghost/releases)** are used to contain stable tagged versions of Ghost.
|
||||||
|
|
||||||
|
|
||||||
|
### Installation / Setup Instructions
|
||||||
### Setup Instructions
|
|
||||||
|
|
||||||
1. Clone the git repo
|
1. Clone the git repo
|
||||||
2. cd into the project folder
|
2. cd into the project folder
|
||||||
|
@ -44,7 +44,17 @@ If you think you've found a problem with Ghost, or you'd like to make a request
|
||||||
|
|
||||||
Front-end can be located at [localhost:2368](http://localhost:2368), Admin is at [localhost:2368/ghost/](http://localhost:2368/ghost/)
|
Front-end can be located at [localhost:2368](http://localhost:2368), Admin is at [localhost:2368/ghost/](http://localhost:2368/ghost/)
|
||||||
|
|
||||||
Whist developing you may wish to use **grunt watch** to watch for changes to handlebars and sass and recompile automatically
|
Whist developing you may wish to use **grunt watch** to watch for changes to handlebars and sass and recompile automatically, see the [Grunt Toolkit docs](https://github.com/TryGhost/Ghost/wiki/Grunt-Toolkit).
|
||||||
|
|
||||||
|
|
||||||
|
### Updating with the latest changes
|
||||||
|
|
||||||
|
Pulling down the latest changes from master will often require more than just a pull, you may also need to do one or more of the following:
|
||||||
|
|
||||||
|
* `npm install` - fetch any new dependencies
|
||||||
|
* `git submodule update` - fetch the latest changes to Casper (the default theme)
|
||||||
|
* `grunt` - will recompile handlebars templates and sass for the admin (as long as you have previously run `grunt init` to install bourbon)
|
||||||
|
* delete core/server/data/*.db - delete the database and allow Ghost to recreate the fixtures
|
||||||
|
|
||||||
|
|
||||||
### SQLite3 Install Instructions
|
### SQLite3 Install Instructions
|
||||||
|
@ -78,7 +88,7 @@ Good, clear and consistent code styles are pivotal in the success of any softwar
|
||||||
* Max line length 120
|
* Max line length 120
|
||||||
* Use unix line endings
|
* Use unix line endings
|
||||||
* Document as you go - we are using groc and jsdoc formats
|
* Document as you go - we are using groc and jsdoc formats
|
||||||
* Write tests, unit tests are witten in Mocha using spec style, functional tests use Casper.js
|
* Write tests, unit tests are written in Mocha using spec style, functional tests use Casper.js
|
||||||
|
|
||||||
For more in depth information please read the official [Ghost Coding Standards](https://github.com/TryGhost/Ghost/wiki/Code-standards).
|
For more in depth information please read the official [Ghost Coding Standards](https://github.com/TryGhost/Ghost/wiki/Code-standards).
|
||||||
|
|
||||||
|
@ -115,14 +125,17 @@ Use the interactive rebase to edit your history. Unless you have good reason to
|
||||||
|
|
||||||
### Check it passes the tests
|
### Check it passes the tests
|
||||||
|
|
||||||
Run `grunt validate` to check that your work passes JSLint and the server-side mocha unit tests. If this fails, your PR will throw an error when submitted.
|
Run `grunt validate` to check that your work passes JSLint, the server-side mocha unit tests, and functional tests written in casperjs. If this fails, your PR will throw an error when submitted.
|
||||||
|
|
||||||
Our functional tests are not yet hooked up to grunt validate, but details on how to run them can be found in `core/test/functional/base.js` if you're making changes to the UI it's worth running these.
|
|
||||||
|
|
||||||
### Need Help?
|
### Need Help?
|
||||||
|
|
||||||
If you're not completely clear on how to submit / update / *do* Pull Requests, please check out our in depth [Git Workflow guide](https://github.com/TryGhost/Ghost/wiki/Git-Workflow) for Ghost.
|
If you're not completely clear on how to submit / update / *do* Pull Requests, please check out our in depth [Git Workflow guide](https://github.com/TryGhost/Ghost/wiki/Git-Workflow) for Ghost.
|
||||||
|
|
||||||
|
## Grunt Toolkit
|
||||||
|
|
||||||
|
Ghost uses Grunt heavily to automate useful tasks such as building assets, testing, live reloading/watching etc etc
|
||||||
|
|
||||||
|
[Grunt Toolkit docs](https://github.com/TryGhost/Ghost/wiki/Grunt-Toolkit) are a worthwhile read for any would-be contributor.
|
||||||
|
|
||||||
## Contributor License Agreement
|
## Contributor License Agreement
|
||||||
|
|
||||||
|
|
34
README.md
34
README.md
|
@ -7,16 +7,34 @@ Visit the project's website at [http://tryghost.org](http://tryghost.org)!
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
|
There are two main ways to get started with Ghost:
|
||||||
|
|
||||||
|
1. Working from a VIP Release - these are pre-built zip packages found on vip.tryghost.org. Installation instructions are below.
|
||||||
|
2. Working from the GitHub repo - instructions can be found in [CONTRIBUTING.md](https://github.com/TryGhost/Ghost/blob/master/CONTRIBUTING.md)
|
||||||
|
|
||||||
### Installing from a VIP Release
|
### Installing from a VIP Release
|
||||||
|
|
||||||
*Please Note:* VIP Releases are pre-built packages, GitHub releases (tags) are not. To install from a GitHub release you need to follow instructions 2-5 from the [Working on Ghost Core](#working-on-ghost-core) section.
|
*Please Note:* VIP Releases are pre-built packages, GitHub releases (tags) are not. To install from GitHub you need to follow the [contributing guide](https://github.com/TryGhost/Ghost/blob/master/CONTRIBUTING.md).
|
||||||
|
|
||||||
1. Once you've downloaded one of the release packages, unzip it, and place the directory wherever you would like to run the code
|
1. Once you've downloaded one of the VIP packages, unzip it, and place the directory wherever you would like to run the code
|
||||||
2. Fire up a terminal (or node command prompt in Windows) and change directory to the root of the Ghost application (where config.js and index.js are)
|
2. Fire up a terminal (or node command prompt in Windows) and change directory to the root of the Ghost application (where config.js and index.js are)
|
||||||
3. run `npm install` to install the node dependencies (if you get errors to do with SQLite, please see the SQLite3 instructions below this list)
|
3. run `npm install` to install the node dependencies (if you get errors to do with SQLite, please see the SQLite3 instructions below this list)
|
||||||
4. To start ghost, run `npm start`
|
4. To start ghost, run `npm start`
|
||||||
5. Visit `http://localhost:2368/` in your web browser
|
5. Visit `http://localhost:2368/` in your web browser
|
||||||
|
|
||||||
|
|
||||||
|
### Updating with the latest changes
|
||||||
|
|
||||||
|
**Warning:** The Ghost file system contains your database and config. Be sure to back these up first.
|
||||||
|
|
||||||
|
1. Make a backup of your data!
|
||||||
|
2. Update the files by pasting new files over the top of old ones. If prompted by your OS or FTP client to 'merge' or 'replace' always choose merge.
|
||||||
|
3. Run npm install
|
||||||
|
4. Run npm update
|
||||||
|
5. Restart the application
|
||||||
|
6. Log out and log back in again.
|
||||||
|
|
||||||
|
|
||||||
### SQLite3 Install Instructions
|
### SQLite3 Install Instructions
|
||||||
|
|
||||||
*Only needed if you experienced errors in Step 3 above - Skip this otherwise*
|
*Only needed if you experienced errors in Step 3 above - Skip this otherwise*
|
||||||
|
@ -37,19 +55,9 @@ Once you have the Ghost server up and running, you should be able to navigate to
|
||||||
2. Enter your user details (careful here: There is no password reset yet!)
|
2. Enter your user details (careful here: There is no password reset yet!)
|
||||||
3. Return to the login screen and use those details to log in.
|
3. Return to the login screen and use those details to log in.
|
||||||
|
|
||||||
|
|
||||||
Note - this is still very alpha. Not everything works yet.
|
Note - this is still very alpha. Not everything works yet.
|
||||||
|
|
||||||
|
|
||||||
### Updating with the latest changes
|
|
||||||
|
|
||||||
Pulling down the latest changes from master will often require more than just a pull, you may also need to do one or more of the following:
|
|
||||||
|
|
||||||
* `npm install` - fetch any new dependencies
|
|
||||||
* `git submodule update` - fetch the latest changes to Casper (the default theme)
|
|
||||||
* `grunt` - will recompile handlebars templates and sass for the admin (as long as you have previously run `grunt init` to install bourbon)
|
|
||||||
* delete core/server/data/*.db - delete the database and allow Ghost to recreate the fixtures
|
|
||||||
|
|
||||||
|
|
||||||
## Versioning
|
## Versioning
|
||||||
|
|
||||||
|
@ -69,7 +77,7 @@ Constructed with the following guidelines:
|
||||||
|
|
||||||
## Reporting Bugs and Contributing Code
|
## Reporting Bugs and Contributing Code
|
||||||
|
|
||||||
Want to report a bug, request a feature, or help us build Ghost? Check out our in dept guide to [Contributing to Ghost](https://github.com/TryGhost/Ghost/blob/master/CONTRIBUTING.md). We need all the help we can get!
|
Want to report a bug, request a feature, or help us build Ghost? Check out our in depth guide to [Contributing to Ghost](https://github.com/TryGhost/Ghost/blob/master/CONTRIBUTING.md). We need all the help we can get!
|
||||||
|
|
||||||
## Community
|
## Community
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue