Libraries
You should review mix.exs, as well as apps/z/mix.exs and apps/z_web/mix.exs to get the most up-to-date list of libraries in use, as well as aliases and other configuration information. However, it's worth calling out a few dependencies on other EXPLO code libraries specifically, since it'll help with understanding the system.
It's recommended to clone all of these repositories to your development machine. Run mix docs
and then open doc/index.html
in each of them and review all of the module docs. Do this for Z as well! We put a lot of effort into documenting this code inline.
- https://github.com/exploration/hive-monitor/ - Z actually has its own real-time link to HIVE! Neat.
- https://github.com/exploration/hive-service/ - You know, for atoms. This comes with HIVE Monitor
- https://github.com/exploration/explo-comm/ - Small utilities for quickly sending SMS (Twilio), Email (Mandrill), and Chat messages (Google).
As a reminder, you can get help for any module in iex by typing h ModuleName
or h ModuleName.function
.