Purpose

To provide an easy way for users to add Docker to their project.

Prerequisites

• Docker
• Docker Compose
• Git

docker -v
# Docker version 19.03.8, build afacb8b7f0

docker-compose -v
# docker-compose version 1.25.0, build unknown

git --version
# git version 2.25.1

This project requires the new apply command introduced in Bridgetown 0.15.0 so make sure if adding to an existing project you are aware of this.

Usage

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/ParamagicDev/bridgetown-automation-docker-compose/master/installer.sh)"

For a specific branch run:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/ParamagicDev/bridgetown-automation-docker-compose/<branch>/installer.sh) <branch>"

You will then be prompted for whether to create a new project or add to an existing one. It will also prompt for where the project is in your filesystem.

Getting Started

Linux

Prior to running docker-compose up --build or docker-compose build make sure to source the docker.env file to prevent permissions issues.

source ./docker.env && docker-compose up --build

Mac & Windows

Mac and Windows users should have no issues running just docker-compose up --build or docker-compose build due to how those OS's run Docker.

docker-compose up --build

# OR

docker-compose build
docker-compose up

Viewing the website

After running docker-compose up --build or docker-compose up you should see the site up and running on localhost:4000

Building a site

To build a bridgetown site run the following command:

docker-compose run --rm web yarn deploy

And this will place all your files into the output folder which can then be used to host your site.

Testing the "apply" command

Right now there is one big integration test which simply checks that the files were created for Docker in a new bridgetown project.

In order for the tests to pass, you must first push the branch you're working on and then wait for Github to update the raw file so the remote automation test will pass

git clone
https://github.com/ParamagicDev/bridgetown-automation-docker-compose/
cd bridgetown-automation-docker-compose
bundle install
bundle exec rake test

Testing with Docker

git clone
https://github.com/ParamagicDev/bridgetown-automation-docker-compose
cd bridgetown-automation-docker-compose
docker-compose up --build

Issues

If you have a ruby-version specified in your repo, make sure it aligns with the Ruby version pulled down by Docker. Check out https://hub.docker.com/_/ruby for a list of officially supported ruby versions.

Sometimes you may run into an issue with the binding of node-sass. To fix the issue simply run

docker-compose run --rm web npm reinstall node-sass