diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 43 |
1 files changed, 20 insertions, 23 deletions
@@ -1,37 +1,34 @@ Cookiecutter Docker =================== -## Step 1: Generate a Project +## What is this repo? -This project is a template for kickstarting my projects. It uses cookiecutter -which is a python module you can install with pip: +This repo is a coookiecutter recipe for spinning up dockerized projects. I use +this recipe on every project that I spin up for encapsulating everything into a +docker container that I can share with other devs easily. -``` -$ pip install cookiecutter -``` +## How do I use it? -Then to start a new project simply call cookiecutter and supply the address of -this repo: +First install [CookieCutter][1] and then use cookie cutter to spin up a new +project from this repo. ``` $ cookiecutter https://github.com/thornycrackers/cookiecutter_docker.git ``` -You will be prompted answer a couple questions about your project and then after -that you will be ready to rock and roll. - -## Step 2: Start using docker - -This project assumes you already have docker installed. After you create you -project you can cd into and run `make` to see a list of commands. To build the -container run. +After that if you have `docker` and `make` installed you can simply use the +following Makefile commands to start running the project. +```bash +$ make build +$ make up +$ make enter +$ make down +$ make clean ``` -make up -``` - -And give it a minute to build. After that you can enter the running container: -``` -make enter -``` +- build: Build the docker container +- up: Spin up the docker container +- enter: Enter the running container +- down: Spin down the container but down remove +- clean: Remove a stopped container |