Add an Hello World example

8 files changed, 129 insertions, 0 deletions

diff --git a/examples/hello_world/README.md b/examples/hello_world/README.md
new file mode 100644
index 0000000..71b7983
--- /dev/null
+++ b/examples/hello_world/README.md
@@ -0,0 +1,16 @@
+Cowboy Hello World
+==================
+
+To compile this example you need rebar in your PATH.
+
+Type the following command:
+```
+$ rebar get-deps compile
+```
+
+You can then start the Erlang node with the following command:
+```
+./start.sh
+```
+
+Then point your browser to the indicated URL.
diff --git a/examples/hello_world/rebar.config b/examples/hello_world/rebar.config
new file mode 100644
index 0000000..6ad3062
--- /dev/null
+++ b/examples/hello_world/rebar.config
@@ -0,0 +1,4 @@
+{deps, [
+	{cowboy, ".*",
+		{git, "git://github.com/extend/cowboy.git", "master"}}
+]}.
diff --git a/examples/hello_world/src/hello_world.app.src b/examples/hello_world/src/hello_world.app.src
new file mode 100644
index 0000000..eeab835
--- /dev/null
+++ b/examples/hello_world/src/hello_world.app.src
@@ -0,0 +1,15 @@
+%% Feel free to use, reuse and abuse the code in this file.
+
+{application, hello_world, [
+	{description, "Cowboy Hello World example."},
+	{vsn, "1"},
+	{modules, []},
+	{registered, []},
+	{applications, [
+		kernel,
+		stdlib,
+		cowboy
+	]},
+	{mod, {hello_world_app, []}},
+	{env, []}
+]}.
diff --git a/examples/hello_world/src/hello_world.erl b/examples/hello_world/src/hello_world.erl
new file mode 100644
index 0000000..eb1e1f5
--- /dev/null
+++ b/examples/hello_world/src/hello_world.erl
@@ -0,0 +1,24 @@
+%% Copyright (c) 2012, Loïc Hoguin <[email protected]>
+%%
+%% Permission to use, copy, modify, and/or distribute this software for any
+%% purpose with or without fee is hereby granted, provided that the above
+%% copyright notice and this permission notice appear in all copies.
+%%
+%% THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+%% WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+%% MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+%% ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+%% WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+%% ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+%% OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+-module(hello_world).
+
+%% API.
+-export([start/0]).
+
+%% API.
+
+start() ->
+	ok = application:start(cowboy),
+	ok = application:start(hello_world).
diff --git a/examples/hello_world/src/hello_world_app.erl b/examples/hello_world/src/hello_world_app.erl
new file mode 100644
index 0000000..03f3e6e
--- /dev/null
+++ b/examples/hello_world/src/hello_world_app.erl
@@ -0,0 +1,26 @@
+%% Feel free to use, reuse and abuse the code in this file.
+
+%% @private
+-module(hello_world_app).
+-behaviour(application).
+
+%% API.
+-export([start/2]).
+-export([stop/1]).
+
+%% API.
+
+start(_Type, _Args) ->
+	Dispatch = [
+		{'_', [
+			{[], toppage_handler, []}
+		]}
+	],
+	{ok, _} = cowboy:start_listener(http, 100,
+		cowboy_tcp_transport, [{port, 8080}],
+		cowboy_http_protocol, [{dispatch, Dispatch}]
+	),
+	hello_world_sup:start_link().
+
+stop(_State) ->
+	ok.
diff --git a/examples/hello_world/src/hello_world_sup.erl b/examples/hello_world/src/hello_world_sup.erl
new file mode 100644
index 0000000..01fbe3b
--- /dev/null
+++ b/examples/hello_world/src/hello_world_sup.erl
@@ -0,0 +1,23 @@
+%% Feel free to use, reuse and abuse the code in this file.
+
+%% @private
+-module(hello_world_sup).
+-behaviour(supervisor).
+
+%% API.
+-export([start_link/0]).
+
+%% supervisor.
+-export([init/1]).
+
+%% API.
+
+-spec start_link() -> {ok, pid()}.
+start_link() ->
+	supervisor:start_link({local, ?MODULE}, ?MODULE, []).
+
+%% supervisor.
+
+init([]) ->
+	Procs = [],
+	{ok, {{one_for_one, 10, 10}, Procs}}.
diff --git a/examples/hello_world/src/toppage_handler.erl b/examples/hello_world/src/toppage_handler.erl
new file mode 100644
index 0000000..ba9159d
--- /dev/null
+++ b/examples/hello_world/src/toppage_handler.erl
@@ -0,0 +1,18 @@
+%% Feel free to use, reuse and abuse the code in this file.
+
+%% @doc Hello world handler.
+-module(toppage_handler).
+
+-export([init/3]).
+-export([handle/2]).
+-export([terminate/2]).
+
+init(_Transport, Req, []) ->
+	{ok, Req, undefined}.
+
+handle(Req, State) ->
+	{ok, Req2} = cowboy_http_req:reply(200, [], <<"Hello world!">>, Req),
+	{ok, Req2, State}.
+
+terminate(_Req, _State) ->
+	ok.
diff --git a/examples/hello_world/start.sh b/examples/hello_world/start.sh
new file mode 100755
index 0000000..b6d1b2d
--- /dev/null
+++ b/examples/hello_world/start.sh
@@ -0,0 +1,3 @@
+#!/bin/sh
+erl -pa ebin deps/*/ebin -s hello_world \
+	-eval "io:format(\"Point your browser at http://localhost:8080~n\")."