Skip to content

Latest commit

 

History

History
26 lines (24 loc) · 2.25 KB

WindowsInstallationReadme.md

File metadata and controls

26 lines (24 loc) · 2.25 KB

Instructions for running Vizor Patches locally using Windows

Written by Maya Lekova

  1. MongoDB
    1. Installation instructions can be found here.
  2. Redis
    1. Download an installer for the Windows version by Microsoft Open Tech group and follow the steps
    2. Check in "Services" that "Redis" is running. By default it runs on port 6379
  3. Node.js
    1. Install nvm-windows: instructions
    2. nvm install 6.11
    3. nvm use 6.11
    4. Running node -v should give you "v6.11.x"
  4. Graphicsmagick
    1. Download from the "windows" section of their website. Q8 x64 version is suitable for setting up Patches.
    2. Open a new cmd window and ensure the installation is successful by running gm help
  5. Additional setup for building the sse4_crc32 module (optional)
    1. Download and install Python
    2. Verify by opening new cmd and running python --version
    3. Install Visual Studio version lower than 2017 (with 2017 there's an issue reported). If the version is >2005 use the appropriate version of cmd to get it building.
  6. Setting up the repo
    1. Download some nice Git client compatible with your version of Windows (personally I use Git for Windows) and clone the repo
    2. npm install && npm install -g gulp
    3. Few deprecated modules appear and (if no success in the previous step) sse4_crc32 may fail completely.

Note about MongoDB: For the server I use a cloud-hosted version on mLab. It provides 0.5GB of storage with MongoDB version 3.4.x. MongoDB server used to be easily installable on consumer versions of Windows, but now on their website there's only installer for Windows Server 2008. If you choose similar cloud provider, the connection string mongodb://<user>:<pass>@<host>:<port>/<dbname> should be set as an environment variable MONGODB prior to running patches and also some modifications in gridfs-storage.js are needed in order to support authentication.