Ghost/README.md

115 lines
4.4 KiB
Markdown
Raw Normal View History

2015-03-12 20:40:21 +01:00
<a href="https://github.com/TryGhost/Ghost"><img src="https://cloud.githubusercontent.com/assets/120485/6622822/c4c639fe-c8e7-11e4-9e64-5bec06c8b4c3.png" alt="Ghost" /></a>
<a href="https://travis-ci.org/TryGhost/Ghost"><img align="right" src="https://travis-ci.org/TryGhost/Ghost.svg?branch=master" alt="Build status" /></a>
2015-03-12 20:40:21 +01:00
![Ghost Screenshot](https://cloud.githubusercontent.com/assets/120485/6626466/6dae46b2-c8ff-11e4-8c7c-8dd63b215f7b.jpg)
2014-10-29 16:34:00 +01:00
2015-03-12 20:40:21 +01:00
![Ghost is a simple, powerful publishing platform that allows you to share your stories with the world.](https://cloud.githubusercontent.com/assets/120485/6626501/b2bb072c-c8ff-11e4-8e1a-2e78e68fd5c3.png)
2013-05-11 18:44:25 +02:00
2015-03-12 20:40:21 +01:00
The project is maintained by a non-profit organisation called the **Ghost Foundation**, along with an amazing group of independent [contributors](https://github.com/TryGhost/Ghost/contributors). We're trying to make publishing software that changes the shape of online journalism.
2015-03-12 20:40:21 +01:00
- [Ghost.org](https://ghost.org)
- [Latest Release](https://ghost.org/download/)
- [Support](http://support.ghost.org/)
2015-03-12 20:40:21 +01:00
- [Theme Docs](http://themes.ghost.org)
- [Contributing Guide](https://github.com/TryGhost/Ghost/blob/master/CONTRIBUTING.md)
- [Feature Requests](http://ideas.ghost.org/)
- [Dev Blog](http://dev.ghost.org)
2013-11-12 10:05:57 +01:00
2015-03-12 20:40:21 +01:00
# Quick Start Install
2013-11-12 10:05:57 +01:00
2015-03-12 20:40:21 +01:00
Make sure you've installed Node.js - We recommend the latest **Node v0.10.x** release.
2015-03-12 20:40:21 +01:00
Ghost is also compatible with **Node v0.12** and **io.js v1.2**, but please note that these versions are more likely to run into installation problems. May contain nuts. Please use the [forum](https://ghost.org/forum/installation/) for help.
2015-03-12 20:40:21 +01:00
1. Download the [latest release](https://ghost.org/download/) of Ghost
1. Unzip in the location you want to install
1. Fire up a terminal
1. `npm install --production`
1. Start Ghost!
- Local environment: `npm start`
- On a server: `npm start --production`
1. `http://localhost:2368/ghost` :tada:
2015-03-12 20:40:21 +01:00
More [install docs](http://support.ghost.org/installation/) here in case you got stuck.
<a name="getting-started"></a>
2015-03-12 20:40:21 +01:00
# Developer Install (from git)
2015-03-12 20:40:21 +01:00
Install Node.js.
2015-03-12 20:40:21 +01:00
```bash
# Node v0.10.x - full support
# Node v0.12.x and io.js v1.2 - partial support
#
# Choose wisely
```
2015-02-28 17:46:16 +01:00
2015-03-12 20:40:21 +01:00
Clone :ghost:
2015-03-12 20:40:21 +01:00
```bash
git clone git://github.com/tryghost/ghost.git
cd ghost
```
2015-03-12 20:40:21 +01:00
Install grunt. No prizes here.
2015-03-12 20:40:21 +01:00
```bash
npm install -g grunt-cli
```
2015-03-12 20:40:21 +01:00
Install Ghost. If you're running locally, use [master](https://github.com/TryGhost/Ghost/tree/master). For production, use [stable](https://github.com/TryGhost/Ghost/tree/stable). :no_entry_sign::rocket::microscope:
2015-03-12 20:40:21 +01:00
```bash
npm install
```
2015-03-12 20:40:21 +01:00
Build the things!
2015-03-12 20:40:21 +01:00
```bash
grunt init
```
2015-03-12 20:40:21 +01:00
Minify that shit for production?
2015-03-12 20:40:21 +01:00
```bash
grunt prod
```
2015-03-12 20:40:21 +01:00
Start your engines.
2014-03-20 12:53:23 +01:00
2015-03-12 20:40:21 +01:00
```bash
npm start
2015-03-12 20:40:21 +01:00
## running production? Add --production
```
2014-03-20 12:53:23 +01:00
2015-03-12 20:40:21 +01:00
Congrats! You made it. BTW you can also just `npm install ghost` if you're into that sort of thing. NPM afficionados can also read up on using [Ghost as an NPM module](https://github.com/TryGhost/Ghost/wiki/Using-Ghost-as-an-npm-module).
2014-03-20 12:53:23 +01:00
2015-03-12 20:40:21 +01:00
More general [install docs](http://support.ghost.org/installation/) here in case you got stuck.
2015-03-12 20:40:21 +01:00
# Deploying Ghost
2015-03-12 20:40:21 +01:00
The easiest way to deploy Ghost is on our official <strong><a href="https://ghost.org/pricing/">Ghost(Pro)</a></strong> hosted platform. This service funds the Ghost Foundation, which makes actively maintaining this project possible.
2015-03-12 20:40:21 +01:00
Also, you get to save yourself a lot of wasted time and headaches by deploying a new instance of Ghost to a managed server with a global content delivery network in just a few clicks.
2015-03-12 20:40:21 +01:00
[Other options](http://support.ghost.org/deploying-ghost/) are available if you prefer playing around with servers by yourself.
2015-03-12 20:40:21 +01:00
# Staying Up to Date
2015-03-12 20:40:21 +01:00
When a new version of Ghost comes out, you'll want to look over these [upgrade instructions](http://support.ghost.org/how-to-upgrade/) for what to do next.
You can talk to other Ghost users on [our forums](https://ghost.org/forum) or chat with Ghost developers in our [public Slack team](https://ghost.org/slack/) (it's pretty awesome). We have a public meeting every Tuesday at 5:30pm London time.
2015-03-12 20:40:21 +01:00
New releases are announced on the [dev blog](http://dev.ghost.org/tag/releases/). You can subscribe by email or follow [@TryGhost_Dev](https://twitter.com/tryghost_dev) on Twitter, if you prefer your updates bite-sized and facetious.
2015-03-12 20:40:21 +01:00
:saxophone::turtle:
2015-03-12 20:40:21 +01:00
# Copyright & License
2013-05-19 17:37:45 +02:00
2015-01-02 15:11:13 +01:00
Copyright (c) 2013-2015 Ghost Foundation - Released under the [MIT license](LICENSE).