vtluu / 3musketeers

Test, build, and deploy your apps from anywhere, the same way!

3 Musketeers

Test, build, and deploy your apps from anywhere, the same way!

Overview

The 3 Musketeers is a pattern for developing software in a repeatable and consistent manner. It leverages Make as an orchestration tool to test, build, run, and deploy applications using Docker and Docker Compose. The Make and Docker/Compose commands for each application are maintained as part of the application’s source code and are invoked in the same way whether run locally or on a CI/CD server.

Why?

Consistency

Run the same commands no matter where you are: Linux, MacOS, Windows, CI/CD tools that supports Docker like GitHub Actions, Travis CI, CircleCI, and GitLab CI.

Control

Take control of languages, versions, and tools you need, and version source control your pipelines with your preferred VCS like GitHub and GitLab

Confidence

Test your code and pipelines locally before your CI/CD tool runs it. Feel confident that if it works locally, it will work in your CI/CD server.

Prerequisites

• Docker
• Compose
• Make

Usage

Create the two following files:

# file: docker-compose.yml
version: '3'
services:
  alpine:
    image: alpine

# file: Makefile

# echo calls Compose to run the command "echo 'Hello, World!'" in a Docker container
echo:
	docker-compose run --rm alpine echo 'Hello, World!'

Then simply echo "Hello, World!" with the following command:

$ make echo

For more information, visit 3musketeers.io.

Website

This repository is the 3musketeers.io website. This section explains how to develop, test, and deploy it using the 3 Musketeers.

Prerequisites

• Docker
• Compose
• Make

Development

# create a .env file
$ make envfile ENVFILE=env.example
# install dependencies
$ make deps

# start vuepress server for local development
$ make dev
# wait till the message 'vite v2.5.3 dev server running at' appears
# access the website in your browser at http://localhost:8080/
# \<ctrl-c\> to stop

# build static site
$ make build

# serve static site for local development
$ make serveDev
# access the website in your browser at http://localhost:8080/
# \<ctrl-c\> to stop

# serve static website (headless)
$ make serve

# test static website
$ make test

# deploy to netlify (do not forget to set the environment variables)
$ make deploy

# clean
$ make clean

# contributing? make sure the following command runs successfully
$ make all

Contributing

Thanks goes to these wonderful people.

The 3 Musketeers is an open source project and contributions are greatly appreciated.

Please visit https://3musketeers.io/about/contributing.html for more information.

Credits

• Docker
• Compose
• Make
• VuePress
• Favicon Generator
• draw.io
• Netlify
  • Deployment badges
  • CLI deploy command
• GitHub Actions
  • Adding a workflow status badge

Stargazers over time

License

MIT