Skip to content

A sinatra-based ruby app for keeping track of when to plant vegetables in your garden or farm

License

Notifications You must be signed in to change notification settings

morinoko/veggie_tracker

Repository files navigation

Veggie Tracker

This is a simple Ruby app built with Sinatra that will allow you to keep track of what vegetables you want to plant and when.

User have the ability to:

  • Create one or more farms/gardens
  • Add vegetables to their farms. Vegetables can be assigned to all farms or specific farms.
  • Keep track of what month the vegetables need to be planted by specifying the planting season for each vegetable.
  • Edit or delete farms and vegetables as needed.
  • See the vegetables to plant this month upon logging in.

Localized to English and Japanese. You can try the app out here:

Future improvements planned:

  • Possibly more specific planting seasons, e.g. beginning/middle/end of month and season range.
  • Better design

Video walkthough on Youtube: https://www.youtube.com/watch?v=PTRAOBUQE5Q

Contributing

You can make a request or report a bug by creating an issue. Or write your own code an submit a pull request:

  1. Fork and clone the repository, following the steps below.
  2. Create a branch named after the feature or bug. For example: git checkout -b feature/new-feature or git checkout -b bug/bug-fix.
  3. Write your code and commit changes with an understandable commit message.
  4. Push to the branch with git push origin feature/new-feature.
  5. Create a pull request: Explain the reason for the change, why the code was written the way it was, etc.

Set up

Prerequisites

  • Ruby
  • SQLite3

Installation

  1. Fork the repository and clone it.
  2. Run bundle install to install gems (If you don't have bundler, first run gem install bundler)
  3. Set up the database with rake db:migrate.
  4. The app uses the dotenv gem for environment variables (currently only one for the session_secret). Create a .env file in the root of the app and add SESSION_SECRET=your_secret (replace the your_secret with your own secret. Check Sinatra's "Session Secret Generation" section in their Readme for recommendations.
  5. Run shotgun to run the app locally at http://localhost:9393/. That should be it!

Tests

This app has a simple test suite that uses Rspec. Tests can be run with rspec spec.

License

Veggie Tracker is available as open source under the terms of the MIT License.

About

A sinatra-based ruby app for keeping track of when to plant vegetables in your garden or farm

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published