spacecruft
/
Farmbot-Web-App
1
0
Fork 0
Code Issues Pull Requests Releases Activity
Farmbot-Web-App/README.md

3.9 KiB
Raw Blame History

Build Status codebeat badge Coverage Status (we're working on it)

Do I need this?

This repository is intended for software developers who wish to modify the frontend of the FarmBot Web App or host it on their own server. If you are not a developer, you are highly encouraged to use the free hosted web app at my.farmbot.io.

If you would like to report a problem with the web app, please submit an issue.

FarmBot Web Frontend

This is the Javascript / HTML / CSS of the FarmBot web app. It depends on a backend API (my.farmbot.io by default).

Developer Setup

LATEST STABLE VERSION IS HERE ⭐ ⭐ ⭐

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

Deploy to Production

NOTE: The Web API deployment will automatically build the latest version of the frontend and mount it in the web server. The instructions below are intended for reference purposes, or for users who wish to host their frontend code on a different server than their API.

  1. (optional, usually not needed) If you have an NPM module that needs to get baked into the build, pass the NPM modules name in as NPM_ADDON=foo
  2. run npm run build
  3. Copy the contents of /app into your webserver and it will be accessible via /.
  4. Visit / on your web server to verify installation.
  5. Submit an issue if you hit problems during the installation.

Debugging external devices (DEV ONLY)

Weinre is included in this project. To utilize it, head over to the /src directory of the app, add a file called config.json, and populate it with this:

{
    "ip_address": "YOUR-IP-ADDRESS"
}

Then, in your console, weinre --boundHost YOUR-IP-ADDRESS --httpPort 8081. This should run in tandem with the rest of your project. Then navigate to http://YOUR-IP-ADDRESS:8081/client/#anonymous. After adding the config.json, you may be required to npm start again.

Want to Help?

Check out the Low Hanging Fruit.

Also, if you're experiencing UI/UX issues, please include any possible specifications (device type, device OS, and device browser) to help in the debugging process. Bonus points for GIFs and screenshots. ✊

Translating the app into your language

Thanks for your interest in internationalizing the FarmBot web app! To add translations:

  1. Fork this repo
  2. Create a yy.js file in /public/app-resources/languages/ where yy is your language's language code. Eg: ru for Russian. If your language already has a file, then you can skip this step.
  3. Search the application for calls to t(). Any file that imports from "i18next" will have strings that require translation.
  4. When you have updated or added new translations, commit/push your changes and submit a pull request.