spacecruft
/
Farmbot-Web-App
1
0
Fork 0
Code Issues Pull Requests Releases Activity
Farmbot-Web-App/public
History
Rick Carlino e86d2d196b Bash script for install 2016-09-22 11:12:27 -05:00
..
404.html Added foundation and high voltage. Readme updates, too. 2014-03-31 06:31:38 -07:00
422.html Added foundation and high voltage. Readme updates, too. 2014-03-31 06:31:38 -07:00
500.html Added foundation and high voltage. Readme updates, too. 2014-03-31 06:31:38 -07:00
LICENSE Dont need the dashboard controller anymore 2016-09-22 10:03:43 -05:00
README.md Dont need the dashboard controller anymore 2016-09-22 10:03:43 -05:00
favicon.ico Add `plant_catalog` to left side menu 2015-09-10 15:14:56 -05:00
favicon.png Add `plant_catalog` to left side menu 2015-09-10 15:14:56 -05:00
karma.config.js 9th times a charm 2016-09-22 10:53:24 -05:00
package.json Bash script for install 2016-09-22 11:12:27 -05:00
robots.txt Added foundation and high voltage. Readme updates, too. 2014-03-31 06:31:38 -07:00
tests.webpack.js Dont need the dashboard controller anymore 2016-09-22 10:03:43 -05:00
tsconfig.json Dont need the dashboard controller anymore 2016-09-22 10:03:43 -05:00
tslint.json Dont need the dashboard controller anymore 2016-09-22 10:03:43 -05:00
typings.json 9th times a charm 2016-09-22 10:53:24 -05:00
webcam_url_not_set.jpeg Convert plants.planted_at to datetime, add better "unavailable" image for cams 2016-09-16 08:36:19 -05:00

README.md

Farmbot Web Frontend

This is the Javascript / HTML / CSS related to Farmbot's browser control app. It depends on a backend API (my.farmbot.io by default).

Up and Running

  1. Install node if you haven't already.
  2. git clone https://github.com/FarmBot/farmbot-web-frontend.git
  3. cd farmbot-web-frontend
  4. npm install
  5. run npm start
  6. Visit http://localhost:8080/

Deploy to Production

  1. run npm run build
  2. Upload tools/dist/farmbot-production.min.js to your server.
  3. Add <script src="entry.min.js"> to the page at app/index.html. This is the only endpoint we support at the moment. PRs welcome.
  4. Please, raise an issue if you have any trouble setting up.

Configuration

All config is in the user auth token. There's no need to point to an MQTT URL or a particular bot. That information is contained in your auth token.

Low Hanging Fruit

Are you a developer? Do you want to help? Don't know where to start?

Here are some easy-to-do tasks that our (small) team hasn't gotten around to yet:

  • Writing unit tests for existing code.
  • Factoring out implcity any types. This was originally a vanilla JS project that later became TypeScript. We have a lot of "unsafe" code that does not have type annotations yet.
  • DRY up URL usage into a URL config object. A lot of AJAX requests are still relying on hardcoded strings rather than DRY configuration.
  • Any comment in sourcode with the word HACK or TODO.