Skip to content

calforcal/fe_zero_waste_kitchen

Repository files navigation

zero_waste_kitchen

Welcome!

At Zero Waste Kitchen we're here to combat the growing problem of food waste in the United States. American households generate an estimated 42 billion pounds of food waste each year. This is enough food to feed 21 million people each year.

The consequences of this waste not only has a direct impact on people but far reaching effects for the planet. 96% of this waste ends up in the landfill - resulting in roughly 12 Million Tons of CO2 emissions. That amount of emissions is equivalent to powering 1.5 million homes for a year, or driving a car 2.6 million miles.

Our app is aimed at helping people eliminate food waste in their homes by providing recipes based on ingredients that will soon spoil and contribute to food waste. We hope to inspire users to waste less, save more and have an increased awareness around their personal impact and ability to contribute by having a Zero Waste Kitchen.

Project Repos and Links

Repos

  1. Frontend Repository
  2. Backend Repository

Production Deployment

  1. Frontend Production
  2. Backend Production

Contributors

Repo Installation

In your terminal run the following commands to clone the repositories:

Frontend

 git clone [email protected]:calforcal/fe_zero_waste_kitchen.git

Backend

 git clone [email protected]:calforcal/be_zero_waste_kitchen.git

Installing the Gems Locally

 bundle install

Front API Keys Needed

Both of these keys will need to be requested from an Admin (see above)

  • GOOGLE_OAUTH_CLIENT_ID
  • GOOGLE_OAUTH_CLIENT_SECRET
  • ZWK_API_KEY

Google OAuth Documentation can be found HERE

Backend API Keys Needed

Installing Figaro

Figaro Gem Docs

In your terminal run:

 bundle exec figaro install

In the new file config/application.yml

Post your keys as they are listed above in this file, for both frontend and backend.

Testing the Repositories

Start up BOTH Servers (Frontend / Backend) by running the following command in each terminal:

 rails s

To run the full test suite:

 bundle exec rspec

Wireframes / Screenshots

Home Page

image

Register / Google Pre-Login

Google Login

User Dashboard

Recipe Search

Recipe Search Results

Recipe Show Page

Recipe Cook Page

Recipe Post Cook

Recipe Saved

Recipe Saved Dropdown

Recipe Cooked Dropdown

ZWK JSON Contract

Backend Endpoints

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •