6. Frequently Asked Questions

6.1. General

6.1.1. What is the Erlang setup for developer?

6.1.2. How do I build this project on Ubuntu?

The following packages must be installed otherwise the NIF (c code) for eleveldb will fail to build. Note that libssl-dev is required by snappy (a requirement of eleveldb).

sudo apt-get install build-essential sudo apt-get install libssl-dev

Clean the project as follows:

./rebar3 clean beampacket

The following command will clean the complete project.

./rebar3 clean -a

Make a release build in the local system.

./rebar3 release

Run a production build in the local system.

./rebar3 as prod tar

6.1.3. How do I run app in shell mode?

./rebar3 shell –apps beampacket

6.1.4. How do I run shell with all the code but not start app?

erl -pa _build/default/lib//ebin/

6.1.5. How do I test and create code coverage?

TODO

6.1.6. How do I run EUnit tests?

TODO

6.1.7. How do I generate code documentation?

The code documentation is generated via edoc<http://erlang.org/doc/apps/edoc/chapter.html> as follows:

./rebar3 edoc

The output is generated in doc/ subfolder.