Skip to content

Latest commit

 

History

History
94 lines (74 loc) · 5.47 KB

README.md

File metadata and controls

94 lines (74 loc) · 5.47 KB
Raw

KIDS EAT

Published on Google Play Store: https://play.google.com/store/apps/details?id=com.kidseat.kidseat

Table of Contents

  1. Overview
  2. Installation Guide
  3. Product Spec
  4. Wireframes
  5. Schema
  6. License

Overview

Description

Kids Eat is an Android app that helps notify low-income local community members of the locations and times of free meal distribution sites organized by the non-profit Berea Kids Eat in Berea, KY. The app serves as a centralized platform for the organization to manage all of its meal events.

About Kids Eat

  • App Type: Android Mobile Application; Uses Java, Cloud Firestore database, Cloud Storage, Cloud Functions, Firebase Authentication, Google Maps API, and Places API.
  • Story: Grow Appalachia is a non-profit organization located in Berea, KY, with a mission to combat food insecurity and malnutrition in the Appalachian region. Berea is home for 15,000 people, 30% of whom live below the poverty line while the national average rate for poverty is 12%. To address the problem, Grow Appalachia started the Berea Kids Eat program in a partnership with Berea College and the United States Department of Agriculture (USDA). Berea Kids Eat aims to fight food insecurity within the town of Berea. The program provides free lunch and breakfast to youths aged 18 or less, especially during the summer break period when the food budget of families increases.
  • Problem: The organization was facing difficulties in notifying families about the locations and times of their programs and meal distribution sites. Kids Eat mobile application allows Berea Kids Eat program to have a centralized platform for managing its events and providing details about them.

Installation Guide

The app can be installed and tested with the following steps:

  1. Install Android Studio on your machine.
  2. Create an Android Virtual Device (AVD) in your Android Studio.
  3. Clone the Kids Eat repo to your local machine.
  4. Open the cloned local project in Android Studio.
  5. Run the app.

Product Spec

Video Walkthrough

Here's a walkthrough of implemented user stories:

User View (How users access the information about meal sites):

Video Walkthrough

Admin View (How organizations manage their events):

Video Walkthrough

GIF created with LiceCap.

User Stories

  • App Authentication system allows both admin and regular users to use the same app to manage and view events.
  • User can sign up and create an account and by default will become a regular user, i.e. not admin.
  • User can sign in and out as a regular user.
  • User can view the list of latest 20 events posted on Kids Eat.
  • User can pull to refresh the latest 20 events posted on Kids Eat.
  • User can see details of each event in a separate activity.
  • The user can switch between 2 tabs: viewing list of all events (feed view) and location markers on a map for each event (map view) using fragments and a Bottom Navigation View.
  • User can see location markers of only upcoming events on a map, i.e. past events are automatically removed.
  • Admin/Organizer can sign in and out as admin.
  • Admin/Organizer can view a list of events.
  • Admin/Organizer can create events using a form.
  • Admin/Organizer can upload images and search for locations using Places API.
  • Admin/Organizer can update previously created events.
  • User can receive push notifications in the background.

Wireframes

Schema

Property Type Description
name String name of the event
description String event details
image Reference image of event that organizer posts
date String date when the event will take place
time String time when the event will take place
address String address of the event
meal_type String the type of meal provided at the event
createdAt Timestamp date when event is created
latlng Geopoint lat/long of event location
facebook_link String link to the event posted on Facebook
instagram_link String link to the event posted on Instagram

License

Copyright 2020 Kids Eat

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.