Back to Installation

Bridgetown on Windows

Help Needed! This Documentation page is in need of review and possible revision. Can you help us out?
Weโ€™d greatly appreciate it! ๐Ÿ˜ƒ๐Ÿ‘

The easiest way to use Bridgetown on Windows is to install the Windows Subsystem for Linux. This provides a Linux development environment in which you can install Bash, Ruby, and other tools necessary to run Bridgetown in an optimized fashion.

Try reading these excellent instructions by GoRails to install Ubuntu Linux on Windows, and then once youโ€™ve reached the โ€œInstalling Railsโ€ portion, you can come back and continue:

Install Node and Yarn

Node is a Javascript runtime that can execute on a server or development machine. Yarn is a package manager for Node packages. Youโ€™ll need Node and Yarn in order to install and use Webpack, the frontend asset compiler that runs alongside Bridgetown. Yarn is also used along with Concurrently and Browsersync to spin up a live-reload development server.

curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list

sudo apt update
sudo apt-get install -y nodejs yarn

Install Bridgetown

Now all that is left is to install Bridgetown!

gem install bridgetown -N

Create a new Bridgetown site at ./mysite, as well as run bundle install and yarn install automatically:

bridgetown new mysite

cd mysite

Now you should be able to build the site and run a live-reload server:

$ yarn start

Try opening the site up in http://localhost:4000. See something? Awesome, youโ€™re ready to roll! If not, try revisiting your installation and setup steps, and if all else fails, reach out to the Bridgetown community for support.

Top Top: Adding Concurrently Processes

Want to run even more background processes or change up your build tools? Take a look at the provided sync.js script and read up on the Concurrently documentation to see which options are available.

Back to Installation