Skip to content
This repository has been archived by the owner on May 29, 2023. It is now read-only.

Latest commit

 

History

History
37 lines (24 loc) · 2.92 KB

install.md

File metadata and controls

37 lines (24 loc) · 2.92 KB
Raw

Installing Calypso

Quick Summary of Steps

  1. Check that you have all prerequisites (Git, Node, NPM). See below for more details.
  2. Clone this repository locally.
  3. Add 127.0.0.1 calypso.localhost to your local hosts file.
  4. Execute make run from the directory of the repository.
  5. Open calypso.localhost:3000 in your browser.

Prerequisites

To be able to clone the repo and run the application on Mac OS X or Linux you need:

  • Install the Node.js and matching NPM versions listed in the engines section of package.json. On Mac OS X using nvm or n makes it easy to manage node versions.
  • Git. Try the git command from your terminal, if it's not found then use this installer.
  • The repository also uses make to orchestrate compiling the JavaScript, running the server, and several other tasks. On Mac OS X, the easiest way to install make is through Apple's Command Line Tools for Xcode (requires free registration).

On Windows, please follow these setup steps to install the prerequisites, or see the alternate install instructions further down.

Installing and Running

Clone this git repo to your machine via the terminal using the git clone command and then run make run from the root Calypso directory:

$ git clone https://github.com/Automattic/wp-calypso.git
$ cd wp-calypso
$ make run

The make run command will install any npm dependencies and start the development server. When changes are made to either the JavaScript files or the Sass stylesheets, the build process will run automatically. In some cases it will even automatically reload the code in the browser (for React components code). The build process compiles both the JavaScript and CSS to make sure that you have the latest versions of both.

To run Calypso locally, you'll need to add 127.0.0.1 calypso.localhost to your hosts file, and load the app at http://calypso.localhost:3000 instead of just localhost. This is necessary, because when running locally Calypso is using the remote version of the WordPress.com REST API, which allows only certain origins via our current authentication methods.

Alternate install: Vagrant

Building Calypso natively is fairly easy on Mac OS but a bit of a pain on Windows. Luckily there's the awesome wp-calypso-bootstrap alternative development environment (using Vagrant and Puppet). This tool enables you to vagrant up and run Calypso quickly on Windows.