Food Resources

Background

This is a project of Code for UV in partnership with Little Rivers Health Care.

Code for UV is a Code for America Brigade based in the Upper Valley region of New Hampshire and Vermont. The Upper Valley is a rural area, and many families live in a food desert, meaning they are 10 miles or more away from food, especially fresh produce. Our app aims to support Little Rivers' goal of increasing food access for residents of this region by producing an online guide to local food resources that is up-to-date, searchable, mobile-friendly, and offline-accessible.

Developer Setup

This is assuming that you are running this on a Mac. If you are on a Windows machine, you may want to first install WSL2 (Windows Subsystem for Linux 2), and then you should be able to follow these steps.

Prerequisites

• PostgreSQL 14
  • Recommend installing via homebrew: brew install postgresql@14
• Ruby 3.1.2
  • Recommend installing via rbenv
• Bundler 2.3.11: gem install bundler
• RubyGems 2.5.0 or higher
  • Check your current version: gem --version
  • If needed, update version: gem update --system

Running the app locally

• Set your database username as an environment variable if different from postgres:
  • Create .env file from .env.example: cp .env.example .env
  • Update file to specify your database username, e.g.: DATABASE_USERNAME=yourusername
• Install Ruby dependencies: bundle install
• Setup database: bin/rails db:setup
• Start server: bin/rails s
• In a separate terminal window, run Tailwind CSS in watch mode: bin/rails tailwindcss:watch
• Visit localhost:3000 to see the app

Running tests

TBD

Tailwind CSS

We are using Tailwind CSS for our CSS styles. Check out their documentation for more information on how to use it.

Deployment

This app is hosted on Heroku. Merging pull requests to the master branch triggers an auto-deploy.

Wireframe Designs

Wireframe designs can be found in lib/wireframes.

Contributing

This is an all volunteer-run project, and pull requests are very welcome! Check out our issues for a list of tasks that need contributions. Join the Code for UV Slack to ask questions and connect with other volunteers.

Code of Conduct

This project and related activities are subject to a Code of Conduct and Anti-Harrassment Policy. Please familiarize yourself with it before making contributions.

Special Thanks

Special thanks to Tailwind Labs for donating a license of Tailwind UI to this project!