Harvest Helper Save

Provides growing, harvesting and recipe information for the 45 plants in the database as well as a json api so that people can hopefully use this data to build other apps.

Project README

Harvest Helper

One of my friends runs an organization in Indianapolis that manages 7 urban farms and gives produce and plant starts to the community. She said that there is often a scenario where she will give folks plant starts and provide verbal instructions on how to grow the plant but no other resource. This app is meant to be that resource. It provides growing, harvesting and recipe information for the 45 plants in the database as well as a json api so that people can hopefully use this data to build other apps.

Production Hosted here Api Information Hosted here

User Workflow

user workflow

Goals

Mobile UX Design

Since folks don't often take their computers into their gardens, I decided to make this app's design mobile focused. It looks better on the phone than it does on a laptop. Pull requests always accepted :)

Technical Overview

  • Full stack ruby-on-rails
  • jQuery/Ajax
  • Devise Auth
  • Ruby Geocoder
  • Edamam API
  • Amazon Web Services S3 API
  • Paperclip
  • Testing with rspec and Capybara

Setup

  1. Clone the repo: git clone [email protected]:damwhit/harvest_helper.git
  2. Navigate to the root of the project: cd harvest_helper
  3. Install dependencies: bundle
  4. Create the database: rails db:create
  5. Run migrations: rails db:migrate
  6. Start the server: rails s

Testing

All testing in Harvest Helper was done via RSpec-rails. I used shoulda matchers to test database validations and relationships. Our coverage was tested using simplecov.

Running tests

Once you have the repo cloned, make sure to reset the database on your local machine and bundle.

In order to run the tests, enter rspec in the command line.

If you would like to run a specific test enter, the whole path of that test, preceeded by the rspec command: ie.

rspec spec/path_to_file/file_name.rb

In order to see coverage for our testing suite simply type the command open coverage/index.html and it will show the index page for our simple cov code coverage.

Happy testing!

Open Source Agenda is not affiliated with "Harvest Helper" Project. README Source: damwhit/harvest_helper
Stars
82
Open Issues
22
Last Commit
11 months ago
License
MIT

Open Source Agenda Badge

Open Source Agenda Rating