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

Latest commit

 

History

History
70 lines (57 loc) · 2.97 KB

windows.md

File metadata and controls

70 lines (57 loc) · 2.97 KB
Raw

Installing Calypso on Windows

The set up for Windows is a bit more complicated than if you were on a *nix system. This is because Node.js does not build under Cygwin or MinGW anymore, so we are stuck with the Windows build which uses Windows-style paths (C:\Windows\system), while most of our build utilities use Unix style paths (/home/stuff/here) and they don't play well together.

This is a complicated configuration and it's important to follow all instructions and settings in the guide. In particular, when installing any of the following tools, be sure to use paths that do not have spaces in them.

  1. Install Git for Windows. Make the following changes to the default settings:

    • Install to a path without spaces
    • Select "Use Git from the Windows Command Prompt"

  2. Install Node.js through the normal Windows installer. Make the following changes to the default settings:

    • Install to a path without spaces

  3. Install MSYS2. The default settings are fine.

  4. For the following commands and generally for working with Calypso, use the MSYS2 Shell that's been added to your Start menu.

  5. Make sure to follow the installation instructions for MSYS2 and update:

    pacman --needed -Sy bash pacman pacman-mirrors msys2-runtime
# restart MSYS2
pacman -Su

  6. Install make:

    pacman -S make

  7. Make sure that git is available and the Windows version is used (do not install git from MSYS2). Also, double check that the reported path does not contain spaces.

    which git
/c/git/cmd/git

  8. And you're done - you can follow the normal instructions from now on!

The development setup for Calypso uses socket.io, which has some native dependencies. These are optional, but because native addons via node-gyp are problematic on both Windows and MSYS (see node-gyp #629, #740), you may see some errors as they try to build. As long as they are all related to warning messages like the following:

npm WARN optional dep failed, continuing [email protected]
npm WARN optional dep failed, continuing [email protected]
npm WARN optional dep failed, continuing [email protected]

then this should only affect the performance of the socket.io library, not its functionality.