README.md

docker-compose-project

A template for docker-compose projects.

Content: (Templates and scripts)

• scripts (convenient scripts for frequently used, necessary commands)
• .editorconfig *
• .gitignore *
• .pre-commit-config.yaml (pre-commit install) *
• .travis.yml (travis lint .travis.yml) **
• Dockerfile **
• LICENSE (MIT) *
• Makefile (for commands: make, make clean, etc.) *
• README.md **
• docker-compose.yml **
• env.example **

* Can be used out-of-the-box or change as needed for your project.

** Requires changing to suit your project's need.

How to use

• Fork and select this as template when creating a new repo on Github
• Or click on Use this template on this repo and create a new repo on Github
• Or clone/download and use locally
• Modify docker-compose.yml
• Modify Dockerfile
• Modify env.example
• Run make and you are good to go!
• Run make up to start containers
• Run make down to stop/remove containers
• Run make clean to clean up and start fresh
• Or use the scripts directly. i.e. ./scripts/init.sh, ./scripts/build.sh

Refer to Makefile to see the recipes.