2015-03-09 04:00:06 -06:00
[![Code Climate ](https://codeclimate.com/github/FarmBot/farmbot-web-app.png )](https://codeclimate.com/github/FarmBot/farmbot-web-app)
[![Build Status ](https://travis-ci.org/FarmBot/farmbot-web-app.svg )](https://travis-ci.org/FarmBot/farmbot-web-app)
2015-03-13 05:12:25 -06:00
[![Test Coverage ](https://codeclimate.com/github/FarmBot/farmbot-web-app/badges/coverage.svg )](https://codeclimate.com/github/FarmBot/farmbot-web-app)
2015-08-19 09:37:13 -06:00
# STOP!! You might not need this!
2015-09-18 23:32:54 -06:00
This repo is intended for developers who build the [Farmbot Web App ](http://my.farmbot.io/ ). **If you are not a developer** , you are highly encouraged to use [the publicly available web app ](http://my.farmbot.io/ ).
2015-08-19 09:37:13 -06:00
If you are a developer interested in contributing or would like to provision your own server, you are in the right place.
2015-03-13 05:12:25 -06:00
# Farmbot Web App
2014-03-11 20:58:53 -06:00
2015-03-13 05:12:25 -06:00
This Repo is the Web based side of FarmBot. It allows users to control the device from their web browser. **We're getting closer to launch, but it this is an unstable pre-alpha repo.**
2014-03-31 07:31:38 -06:00
# Developer setup
2014-08-06 06:12:12 -06:00
1. `git clone git@github.com:FarmBot/farmbot-web-app.git`
2. `cd farmbot-web-app`
2014-04-10 07:27:53 -06:00
3. [Install MongoDB ](http://docs.mongodb.org/manual/tutorial/install-mongodb-on-os-x/ )
4. Start Mongo if you have not already done so. (typically via the `mongod` command)
2014-03-31 07:31:38 -06:00
3. `bundle install`
2015-09-26 17:09:54 -06:00
4. `npm install`
5. `rails s`
6. Go to `http://localhost:3000`
2014-03-11 20:58:53 -06:00
2015-08-19 09:37:13 -06:00
**We can't fix issues we don't know about.** Please submit an issue if you are having trouble installing on your local machine.
2014-07-04 16:39:42 -06:00
2015-08-19 09:37:13 -06:00
## Running Specs
2014-07-04 16:39:42 -06:00
2015-08-19 09:37:13 -06:00
Please run them before submitting pull requests.
2014-07-04 16:39:42 -06:00
* `bundle exec rspec spec`
2014-03-11 20:58:53 -06:00
# How to Contribute
2014-06-12 07:43:30 -06:00
* Pull requests are always appreciated, but *please*
* Write tests.
* Follow the [Ruby Community Style Guide ](https://github.com/bbatsov/ruby-style-guide ).
2014-07-04 16:39:42 -06:00
* Raise issues. We love to know about issues. Even the issues you think are only relevant to your setup. Just submit issues if you have issues.
2014-03-11 20:58:53 -06:00
# Roadmap
2015-08-19 09:37:13 -06:00
As of July 2015, the Web App supports scheduling and manual movemnt of FarmBot via the browser.
2014-03-11 20:58:53 -06:00
2014-07-30 05:12:49 -06:00
Eventually, the app hopes to be a rich environment for users to manage their FarmBot and gain insights into the farming decision process.
2014-06-12 07:43:30 -06:00
2014-07-31 06:47:29 -06:00
# nice-to-haves
2015-08-19 09:37:13 -06:00
* Actually make use of MeshBlu response objects (with timeouts), instead of just screaming commands at the device.
2014-07-31 06:47:29 -06:00
* Better test suite for angular side of things.
2014-06-12 07:43:30 -06:00
# Accomplishments
2015-08-19 09:37:13 -06:00
July 2015:
* 1.0 release candidate.
* Full manual control of device via browser.
* Scheduling of sequences and commands.
2014-07-30 05:12:49 -06:00
JULY 2014:
* Changed UI Components
* MeshBlu upgrade
* Production server changes
2014-06-24 08:12:14 -06:00
JUNE 2014:
2014-06-12 07:43:30 -06:00
2014-06-24 08:12:14 -06:00
* Achieved Device movement in the real world.
2014-06-12 07:43:30 -06:00
MAY 2014:
* Deployed pre-alpha staging server (contact Rick Carlino for contributor access)
2014-08-04 01:01:23 -06:00
* Connected to [MeshBlu ](http://www.skynet.im/ ), formerly SkyNet.
2014-06-12 07:43:30 -06:00
* Finished in browser device config for skynet.
2014-06-24 08:12:14 -06:00
APRIL 2014:
2014-06-12 07:43:30 -06:00
2014-06-24 08:12:14 -06:00
* Finished basic user registration
* Functional mockups