• Install Chocolatey
• Install Git
  • Install Hub
  • SSH Keys
• Install OpenJDK
• Install NVM
• Install Yarn
• Install Podman
• Install Jekyll

Overview

This document is intended to provide the quickest path to a fully functional development environment for developers planning to contribute to the Check-Ins project using WindowsOS.

Install Chocolatey (Optional)

Note: If you prefer to use Windows installers for installing required software, then you can skip installing Chocolatey.

Chocolatey is a package manager for Windows that automates the process of installing, updating, and configuring software. It is similar to package managers like apt-get on Ubuntu or Homebrew on macOS. For complete information on using Chocolatey, visit https://docs.chocolatey.org/en-us/getting-started

Installation guide: https://chocolatey.org/install

Install Git

From the commandline run:

git --version

If git is not yet installed on your machine, then you can install via Chocolatey:

choco install git.install

Or use the latest installer: https://git-scm.com/download/win

Install Hub

Since this project is hosted on GitHub, using Hub will make many common tasks more convenient. You can install hub via Chocolatey:

choco install hub

Create a git alias (optional)

For bash, add the line to your .bash_profile or .bashrc or .gitconfig file.

alias git=hub

SSH Keys

If you haven’t already, you will want to configure git to use ssh for connecting to GitHub.

Install OpenJDK

Install OpenJDK 21 with Chocolatey:

choco install openjdk --version=21.0.2

or download the latest installer: https://www.oracle.com/java/technologies/javase/jdk21-archive-downloads.html

Install NVM

In order to install or update NVM, you need to run the following from the command line:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.0/install.sh | bash

Enable NVM Shell Completion

Add the following to the appropriate shell config (.zshrc, etc.)

export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"  # This loads nvm
[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"  # This loads nvm bash_completion

Install Yarn

choco install yarn

Install Podman

This project uses Podman for containerization.

If you are using Docker Desktop, you can skip this section, and set an environment variable via USE_DOCKER_DESKTOP=1 in your Windows environment variables. This will enable Ryuk for cleaning up old containers under testing.

Install Podman Desktop: https://podman-desktop.io/

The setup process will ask if you want to install Podman and Podman Compose for the cli. Be sure to do this.

Install Jekyll

This project uses Jekyll for working with documentation:

https://jekyllrb.com/docs/installation/windows/