Local zally Windows installation doesn't work

Hello,

I followed the README documents and related issues and almost installed zally locally on the Windows 10 machine. I am able to execute all gradlew tasks, but when I am executing the bootRun it stops after initiating the back-end server 0% as script indicated). Back-end (localhost:8000) for sure works since the command zally --linter-service "http://localhost:8000" --format pretty lint no_must_violations.yaml brings the meaningful results. I can also get the list of the rules from the browser executing http://localhost:8000/supported-rules as well as all 200+ tests executed successfully. Attached is the complete output from my DOS shell.

On the other hand, it never brings front-end running on 8080 port. I am guessing it might be some proxy setting between zally back-end and front-end need to be done, but not sure.

I also successfully mounted / build the web-ui component separately with zally server running in its current state. Again all build tasks are complete successfully with npm and / or yarn, but I can run neither dev nor production builds. Both brings similar exceptions ‘‘NODE_ENV’ is not recognized as an internal or external command,’. DEV mode also brings some JS exception. Again, the whole output from another DOS shell is attached.

Please let me know if any other information needed.

FullZallyDOSShellOutput.txt

WebUIZallyDOSShellOutput.txt

[maxim-tschumak]

Let’s add this page to the docs.

[roxspring]

These are tested notes based on my setup, happy to move them into a markdown document in the project if that helps…

Building Under Windows Subsystem for Linux

The following notes document my working environment for building and testing a full Zally installation from a Windows 10 workstation.

Prepare Windows Environment

• Download and install Docker for Windows

  • https://hub.docker.com/editions/community/docker-ce-desktop-windows

• Open Microsoft Store

  • Search for linux

  • Install Debian (or Ubuntu, other linuxes may need different commands for package management)

  • Launch the Debian console

Prepare Linux Environment

• In the Debian console:

  • enter a username & password to complete the installation

• Install some general prerequisites

  sudo apt-get update -y && sudo apt-get install -y git openjdk-8-jdk curl make g++
  

  (I was quite surprised to see that make and g++ were necessary to build some dependency of the web-ui)

• Install NodeJS

  • https://github.com/nodesource/distributions/blob/master/README.md#installation-instructions

  curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
  sudo apt-get install -y nodejs
  

• Make Windows docker binaries available on linux path:

  sudo ln -s /mnt/c/Program\ Files/Docker/Docker/resources/bin/docker.exe /usr/local/bin/docker
  sudo ln -s /mnt/c/Program\ Files/Docker/Docker/resources/bin/docker-compose.exe /usr/local/bin/docker-compose
  sudo ln -s /mnt/c/Program\ Files/Docker/Docker/resources/bin/docker-machine.exe /usr/local/bin/docker-machine
  sudo ln -s /mnt/c/Program\ Files/Docker/Docker/resources/bin/docker-credential-wincred.exe /usr/local/bin/docker-credential-wincred
  

• Clone Zally into a folder easily addressable under Windows (C:\Zally)

  cd /mnt/c
  git clone https://github.com/zalando/zally
  cd zally
  
  

Build and Run

Run the following script to build and then run the services under docker:

./build-and-run.sh

It’ll take a while but eventually you’ll see something like the following to indicate that we’re ready to connect:

Started ApplicationKt in 36.576 seconds (JVM running for 40.144)

Testing

Use a browser to check that things are working correctly:

• http://localhost:8000/supported-rules - should have a JSON response including a list of rules
• http://localhost:8080/ - should show the UI including Zally icon top left
• http://localhost:8080/rules?is_active=true - should show a list presenting a subset of the rules above

Troubleshooting

Variations on the following error messages are a regular occurrence when building the web-ui under Windows. The command in question can typically be rerun without producing exactly the same occurrence, so incrementally the command gets further each run. (Producing this guide took 5x attempts at the web-ui build before a full run completed).

error An unexpected error occurred: "ENOENT: no such file or directory, copyfile '/home/username/.cache/yarn/v1/npm-react-ace-5.8.0-872d9ee8b664300ed5ab9edac6234bbe90836836/webpack.config.base.js' -> '/mnt/c/zally/web-ui/node_modules/react-ace/webpack.config.base.js'".