View Source Quick start

Start your first project

Nova provides a plugin to make working with the framework a lot easier. One can install it by either using an automated installation or include it manually in the global rebar.config file.

Note :bangbang:

If you require help installing Erlang and/or rebar3 please check https://adoptingerlang.org/docs/development/setup/

Automated installation

Via Curl

sh -c "$(curl -fsSL https://raw.githubusercontent.com/novaframework/rebar3_nova/master/install.sh)"

Via wget

sh -c "$(wget -O- https://raw.githubusercontent.com/novaframework/rebar3_nova/master/install.sh)"

Manual installation

Open your rebar.config file that should reside in ~/.config/rebar3/rebar.config*. If the file does not exist you can just create it. Locate the plugins section of the file and include the nova plugin. The result should look something like the following:

{plugins,[{rebar3_nova,{git,"https://github.com/novaframework/rebar3_nova.git",
                            {branch,"master"}}}]}.

Creating the skeleton

After the installation of the Nova-plugin is done use rebar3 to generate a new project.

rebar3 new nova my_first_nova

$ rebar3 new nova my_first_app
===> Writing my_first_nova/config/dev_sys.config.src
===> Writing my_first_nova/config/prod_sys.config.src
===> Writing my_first_nova/src/my_first_nova.app.src
===> Writing my_first_nova/src/my_first_nova_app.erl
===> Writing my_first_nova/src/my_first_nova_sup.erl
===> Writing my_first_nova/src/my_first_nova_router.erl
===> Writing my_first_nova/src/controllers/my_first_nova_main_controller.erl
===> Writing my_first_nova/rebar.config
===> Writing my_first_nova/config/vm.args.src
===> Writing my_first_nova/src/views/my_first_nova_main.dtl

Now the skeleton have been created and you should be able to start it. Go into the newly created directory and run the serve command.

Note :bangbang:

For the auto-compile/reload to work you need inotify to be installed.

$ cd my_first_app
$ rebar3 nova serve
===> Verifying dependencies...
===> Compiling my_first_app
Erlang/OTP 20 [erts-9.3] [source] [64-bit] [smp:8:8] [ds:8:8:10] [async-threads:0] [hipe] [kernel-poll:false]
...
a lot of progress-reports
...
===> Booted my_first_app
...

If you take a look at http://localhost:8080 you should be greeted by a Nova-page.