Setup on Windows - department-of-veterans-affairs/abd-vro GitHub Wiki
There are two ways to set up the application on Windows:
- Install directly on the Windows OS, using a unix-like command line to execute the scripts
- Install on Ubuntu using WSL
Installing Directly on Windows
-
Git Bash shell: https://git-scm.com/downloads Once install, you need to run the following to make line endings on windows compatible: git config --global core.autocrlf true
-
Docker Desktop: https://docs.docker.com/get-docker/
-
To install hadolint, first install Scoop (https://github.com/ScoopInstaller/Scoop) and follow the instructions here: https://github.com/hadolint/hadolint#install
-
You will also need scoop to install shellcheck: https://github.com/koalaman/shellcheck#readme
-
To install Spectral, find the windows executable and put it on the PATH
For the remaining setup, just follow the instructions on the README https://github.com/department-of-veterans-affairs/abd-vro#readme, executing all commands from within the Git Bash shell (not DOS or Powershell).
I should note that, although this way is simpler, not all services started successfully on docker. Postgres and Rabbit come up successfully but the vro services do not start.
Installing via Ubuntu
- Make Sure wsl2 is enabled
- Download Ubuntu from https://digitaltransfusion.net/ubuntu2004.zip
- extract it to c:\Tools\Ubuntu2004 and start Ubuntu.exe. This will install Ubuntu
- Open a windows command shell (cmd) and type the following:
wsl --set-default Ubuntu-20.04
wsl --set-version Ubuntu-20.04 2
wsl --set-default-version 2
- Enable Ubuntu on Docker:
- Restart wsl
wsl --shutdown
-
Restart docker.
-
Open a new command window (cmd)
-
Type wsl. This should now switch to an Ubuntu shell.
-
type "sudo docker ps" to make sure it works
-
update linux
sudo apt update && sudo apt upgrade
- Install prerequisites
d ~/
sudo apt install openjdk-17-jdk shellcheck
curl https://raw.githubusercontent.com/creationix/nvm/master/install.sh | bash
sudo wget -O /bin/hadolint https://github.com/hadolint/hadolint/releases/download/v1.16.3/hadolint-Linux-x86_64 && sudo chmod +x /bin/hadolint
- type "exit"
- type "wsl"
nvm install 17.0.0
npm install -g @stoplight/spectral-cli
export GITHUB_ACCESS_TOKEN=<replace-with-token-from-github>
cd ~/
mkdir repos, cd repos
git clone [email protected]:department-of-veterans-affairs/abd-vro.git
For the remaining setup, just follow the instructions on Local Setup, executing all commands from within Ubuntu.