aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 920060d88850c398348a52c4d14f352577a0c622 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
Cookiecutter Docker
===================

## What is this repo?

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.

## How do I use it?

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
```

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
```

- 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