Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 2.12 KB

README.md

File metadata and controls

43 lines (31 loc) · 2.12 KB

farmOS Field Kit

Licence Last commit Chat

farmOS Field Kit is a lightweight application for connecting to a farmOS server from any mobile device. It is a Progressive Web App (PWA), meaning it can run from a browser, even offline, and will persist data in between sessions.

Note that the default branch for this repository is develop, not master; develop should represent the most current set of complete features that are only awaiting further testing before release. You should branch or fork off develop and submit pull requests to be merged back into it. The deploy branch represents the latest tagged release.

As of September 2021, the develop branch will point at the latest alpha or beta version for the upcoming 2.0.0 release, compatible with farmOS 2.x. Versions 0.8 and lower will only receive minimal support going forward, with no new feature development. Stay tuned for more details on the forthcoming Field Module API, which will enable developers to develop modules for Field Kit, similar to farmOS modules!

GETTING STARTED

To run the Field Kit in your browser using the Webpack DevServer, clone this repo and run:

# install dependencies
npm install

# serve with hot reload at localhost:8080
npm start

If you would like to install and host a farmOS server yourself, see the official documentation on farmOS.org: https://farmOS.org/hosting/installing

If you would like to pay for hosting, Farmier provides affordable options for individual farms and organizations.

MAINTAINERS

Current maintainers:

This project has been sponsored by: