Skip to content

jks8787/crop_tracker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Purpose

  • This is a very simple CLI written as a ruby gem. 🎉
  • This gem's current function is to track crop yields. 🌳
  • The app is a companion to medium write up, about Creating a CLI ruby gem!. 💻

Dependencies

Install Xcode Tools

xcode-select --install

Install Homebrew

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Install RVM

\curl -sSL https://get.rvm.io | bash -s stable

Load up RVM on shell instantiation

echo '[[ -s "$HOME/.rvm/scripts/rvm" ]] && . "$HOME/.rvm/scripts/rvm" # Load RVM function' >> ~/.bash_profile

Ensure RVM is installed correctly

type rvm | head -1

Install Ruby

rvm install 2.4.0

Install Bundler

gem install bundler

Running

Get the code

git clone git@github.com:jks8787/crop_tracker.git

Use the correct ruby version

rvm use 2.4.0

Install It locally

rake install

To Run Tests

rake spec

Check it out

crop_tracker help

Usage

To Upload a file

  • crop_tracker test_file.txt OR
  • crop_tracker < test_file.txt

To Add A Crop

  • crop_tracker add crop Kale 10oz

To Update An Amount

  • crop_tracker add amt Kale 2oz OR
  • crop_tracker subtract amt Kale 1oz

To Summary

  • crop_tracker summary

To Clear All Data

  • crop_tracker clear

Resources

MIT License

Copyright (c) 2017 Janice K.N. Smith

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

crop_tracker to track your crops ( a simple CLI written as a ruby gem )

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published