Development work on FarmData2 can be divided into two main areas discussed in this document:
- Front End (farmOS Modules/Tabs, Vue Components, Utility Libraries, etc.)
- Back End (Custom FarmData2 API endpoints)
The front end for FarmData2 is contained in the farmdata2_modules
directory. More information about front-end development, documentation, and testing can be found in the:
The back end for FarmData2 is partially based on the farmOS API and partially based on the custom FarmData2 API contained in the farmdata2_api
directory. More information about back end development, documentation and testing can be found in the:
Both the front end and back end of FarmData provide documentation.
To see the documentation open farmdata2/doc/index.html
in a browser.
Documentation is not stored in the repository and must be generated locally (above).
To generate the documentation within the development environment
- Ensure that you are in the
farmdata2
directory. - Run the script
./generate_docs.bash
.
The documentation files will be generated in the doc
directory within the farmdata2
directory.
The details about how tests are written can be found in the README
files for the front-end and back-end development provided above.
The documentation for FarmData2 is generated using JSDoc and the documentation for the VueJS components uses the JSDoc for VueJS Plugin. All necessary tools for generating the documentation are included in the development environment but should you want to install them on your host machine, the versions that are installed in the development environment can be found in the docker/dev/Dockerfile
.
Details about running the front-end and back-end tests can be found in the README
files for the front-end and back-end development provided above.
Details about writing front-end and back-end tests can be found in the README
files for the front-end and back-end development provided above.