poanetwork
/
poa-netstats-agent
mirror of https://github.com/poanetwork/poa-netstats-agent.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
41 Commits 4 Branches 0 Tags 358 KiB
Elixir 100%
Go to file
Felipe Ripoll 31b6c57c1b [#28] adding the initial architecture to /issue 2018-05-16 09:22:41 -06:00
.circleci [#21] Introduce Dialyzer PLT caching through CI step 2018-05-15 16:22:17 +02:00
config [#19] filling the Information struct before starting the WS connection 2018-05-15 08:42:35 -06:00
issue [#28] adding the initial architecture to /issue 2018-05-16 09:22:41 -06:00
lib/poa_agent [#28] adding the handle_message function in docs 2018-05-16 08:42:14 -06:00
test [#18] implementing Ping-Pong and Latency messages 2018-05-15 09:27:54 -06:00
.gitignore [#6] adding some documentation in the modules 2018-05-08 12:58:27 -06:00
LICENSE Initial commit 2018-04-24 10:13:33 -04:00
README.md [16] Document how to get coverage information in README 2018-05-15 15:17:43 +02:00
mix.exs Introduce ExCoveralls for collecting coverage information 2018-05-15 14:37:42 +02:00
mix.lock Introduce ExCoveralls for collecting coverage information 2018-05-15 14:37:42 +02:00

README.md

POAAgent

Coverage Status codecov

TODO: Add description

Documentation

In order to create the documentation

mix docs

Run

POAAgent is an Elixir application, in order to run it first we need to fetch the dependencies and compile it.

mix deps.get
mix deps.compile
mix compile

Run Tests

In order to run the tests we have to run the command

mix test

POAAgent comes also with a code analysis tool Credo and a types checker tool Dialyxir. In order to run them we have to run

mix credo
mix dialyzer

Coverage

To get an HTML coverage report on your own machine try env MIX_ENV=test mix coveralls.html then open cover/excoveralls.html. You can get a simple print-out with env MIX_ENV=test mix coveralls.