Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/KonnorRogers/bridgetown-automation-docker-compose
An automation for adding Docker Compose to Bridgetown
https://github.com/KonnorRogers/bridgetown-automation-docker-compose
bridgetown bridgetown-automation docker
Last synced: 2 months ago
JSON representation
An automation for adding Docker Compose to Bridgetown
- Host: GitHub
- URL: https://github.com/KonnorRogers/bridgetown-automation-docker-compose
- Owner: KonnorRogers
- License: mit
- Archived: true
- Created: 2020-06-14T06:10:07.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-07-13T12:11:39.000Z (over 3 years ago)
- Last Synced: 2024-05-18T23:04:00.471Z (8 months ago)
- Topics: bridgetown, bridgetown-automation, docker
- Language: Ruby
- Homepage: https://bridgetownrb.com
- Size: 163 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Purpose
To provide an easy way for users to add Docker to their project.
## Prerequisites
- Docker
- Docker Compose
- Git
```bash
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
```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/ParamagicDev/bridgetown-automation-docker-compose/master/installer.sh)"
```
For a specific branch run:
```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/ParamagicDev/bridgetown-automation-docker-compose//installer.sh) "
```
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.
```bash
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:
```bash
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
```bash
git clone
https://github.com/ParamagicDev/bridgetown-automation-docker-compose/
cd bridgetown-automation-docker-compose
bundle install
bundle exec rake test
```
### Testing with Docker
```bash
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](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
```bash
docker-compose run --rm web npm reinstall node-sass
```