farmbot_os/docs/project/structure.md

1.0 KiB

FarmBot Source Project structure

The FarmBot OS application is broken into several sub OTP applications.

Commonality

All of these folders share a common structure.

├── lib/ │ ├── application.ex │ └── some_file.ex | ├── test/ | └── test_helper.exs | ├── config/ | └── config.exs | ├─── mix.exs └─── mix.lock
  • The lib folder contains Elixir source code
  • the test folder contains Elixir scripts responsible for testing the lib code
  • the config folder contains Elixir scripts responsible for configuring the current OTP app
  • mix.exs and mix.lock files are responsible describing the OTP app, and managing external dependencies