forked from cloudhead/erlapp.template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
62 lines (43 loc) · 1.62 KB
/
README
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
erlapp.template
a basic erlang/OTP application skeleton
This is a minimal erlang/OTP app, with everything you need to get up and
running. It tries to follow best practices, while providing everything necessary
to start development.
Compared to rebar's "create-app", erlapp is much more complete. It includes
the following files and folders:
ebin/ % .app and .beam files
deps/ % dependencies
dev/
| start % startup script
| start.args % startup arguments
|
priv/ % application-specific files
src/
| erlapp.app.src % erlapp.app template
| erlapp.erl % entry-point
| erlapp_app.erl % application
| erlapp_sup.erl % supervisor
| erlapp_server.erl % gen_server
|
Makefile
rebar.config
.gitignore
erlapp also comes with the sync <https://github.com/rustyio/sync> utility,
which recompiles and reloads changed code.
install
-------
Make sure you have the latest version of rebar installed, then clone this
repo into ~/rebar/templates.
$ mkdir -p ~/.rebar/templates
$ cd ~/.rebar/templates
$ git clone --recursive git://github.com/cloudhead/erlapp.template.git
setup
-----
Create the app skeleton, set `appid` to the app name
$ rebar create template=erlapp appid=myapp
Build the application
$ make all
Start the development console
$ dev/start
Modules should get recompiled/reloaded when their source is changed. You can also
compile the whole project with `make`. Check the Makefile for additional commands.