Skip to main content
Version: Canary

Windows Development Setup

This guide provides a simple setup to start developing a RedwoodJS project on Windows. Many setup options exist, but this aims to make getting started as easy as possible. This is the recommended setup unless you have experience with some other shell, like PowerShell.

If you're interested in using the Windows Subsystem for Linux instead, there is a community guide for that.

Git Bash​

Download the latest release of Git for Windows and install it. When installing Git, you can add the icon on the Desktop and add Git Bash profile to Windows Terminal if you use it, but it is optional.

1-git_components.png

Next, set VS Code as Git default editor (or pick any other editor you're comfortable with).

2-git_editor.png

For all other steps, we recommended keeping the default choices.

Node.js environment (and npm)​

We recommend you install the latest nvm-setup.zip of nvm-windows to manage multiple version installations of Node.js. When the installation of nvm is complete, run Git Bash as administrator to install Node with npm.

3-git_run_as_admin.png

Redwood uses the LTS version of Node. To install, run the following commands inside the terminal:

$ nvm install lts --latest-npm
// installs latest LTS and npm; e.g. 16.13.1 for the following examples
$ nvm use 16.13.1

Yarn​

Now you have both Node and npm installed! Redwood also uses yarn, which you can now install using npm:

 npm install -g yarn

Example of Node.js, npm, and Yarn installation steps

4-install_yarn.png

Congrats!​

You now have everything ready to build your Redwood app.

Next, you should start the amazing Redwood Tutorial to learn how to use the framework.

Or run yarn create redwood-app myApp to get started with a new project.

Troubleshooting​

Beware case-insensitivity​

On Windows Git Bash, cd myapp and cd myApp will select the same directory because Windows is case-insensitive. But make sure you type the original capitalization to avoid strange errors in your Redwood project.

Microsoft Visual C++ Redistributable​

If your machine doesn't have Microsoft Visual C++ Redistributable, then you need to install it from here.