Skip to content

Commit 4740fe4

Browse files
committed
Finish readme
1 parent 410b6fc commit 4740fe4

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,23 @@
1-
# Dockerized Phoenix Initializer
1+
# Phoenix Dockerized Project Initializer
2+
3+
Heavily based on [Starting a Phoenix Project with Docker by Robert Beene](https://echobind.com/blog/using-phoenix-with-docker/)
4+
5+
## Usage
6+
7+
mkdir my_project
8+
cd my_project
9+
curl -L https://github.com/Stratouklos/phoenix_starter/releases/download/0.1/dockerized-phoenix.tar.gz | tar xvz
10+
./init my_project
11+
12+
Subsequent init executions start the project and run ecto.create
13+
14+
## What it does
15+
16+
* Creates a Phoenix image based on the official elixir:1.3.4
17+
* Starts a db container based on postgres:9.6-alpine
18+
* Configures config/dev.exs to talk to the db container
19+
* Starts a web container serving out of localhost:4000
20+
21+
## To release
22+
23+
git archive --format=tar.gz master > dockerized-phoenix.tar.gz

0 commit comments

Comments
 (0)