Farmbot-Web-App/README.md

77 lines
2.7 KiB
Markdown
Raw Normal View History

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-09 04:18:02 -06:00
[![Test Coverage](https://codeclimate.com/github/FarmBot/farmbot-web-app/badges/coverage.svg)](https://codeclimate.com/github/FarmBot/farmbot-web-app)# Farmbot Web App
2014-03-11 20:58:53 -06:00
2014-07-30 05:12:49 -06:00
This Repo is the Web based side of FarmBot. It allows users to control the device from their web browser. **ITS NOT STABLE. WE ARE IN PRE ALPHA.**
# Developer setup
1. `git clone git@github.com:FarmBot/farmbot-web-app.git`
2. `cd farmbot-web-app`
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)
3. `bundle install`
4. `rails s`
2014-05-13 07:55:38 -06:00
5. Go to `http://localhost:3000`
2014-03-11 20:58:53 -06:00
# Running Tests
Please run them before submitting pull requests.
## Ruby Specs
* `bundle exec rspec spec`
## Javascript Specs
* ` bundle exec rake spec:javascript`
2014-03-11 20:58:53 -06:00
# How to Contribute
* Check out [Waffle.io](https://waffle.io/farmbot/farmbot-web-app) for issues that are ready to be worked on.
* Pull requests are always appreciated, but *please*
* Write tests.
* Follow the [Ruby Community Style Guide](https://github.com/bbatsov/ruby-style-guide).
* 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
2014-07-30 05:12:49 -06:00
This project is still in its infancy. Our current focus as of July 2014 is to create a basic system of control for the farmbot user via technologies such as:
2014-03-11 20:58:53 -06:00
2014-03-25 11:18:41 -06:00
* [Farmbot Controller](https://github.com/FarmBot/farmbot-raspberry-pi-controller)
2014-07-30 05:12:49 -06:00
* [MeshBlu IoT Messaging Platform](http://www.skynet.im) ([Github](https://github.com/skynetim/skynet))
2014-03-11 20:58:53 -06:00
* Ruby on Rails
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-07-31 06:47:29 -06:00
# nice-to-haves
* Actually make use of MeshBlu response objects, instead of just screaming commands at the device.
* Display device status.
* Test precision control widget on device.
* Dropdown box to select device (defaults to first)
* Better test suite for angular side of things.
# Accomplishments
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-24 08:12:14 -06:00
* Achieved Device movement in the real world.
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.
* Finished in browser device config for skynet.
2014-06-24 08:12:14 -06:00
APRIL 2014:
2014-06-24 08:12:14 -06:00
* Finished basic user registration
* Functional mockups