Handoff is a mobile application that bridges the communication gap between local organizations such as food banks and non-profits, and community members looking to donate. The app allows organizations to post requests about general or specific needs, and then users can browse through this information through either a request feed or a map that displays requests at the location of the organization. A user might want to use it because it can keep them aware of the needs of organizations, and it provides an easy way to find a place where items to donate can be dropped off.
Go to the following webpage and select Mac/Linux/Windows and Android, then follow the instructions to download the dependancies: http://facebook.github.io/react-native/docs/getting-started.html
Make sure that you install Android 7.0, despite it not being the latest release. Not being on 7.0 creates many issues.
Note: It is possible that installing node will cause an error with user permissions when trying to install the sandbox. The only time we experienced this bug, the following two commands (after "brew install node" partially fails) solved the issue:
sudo chown -R $USER /usr/local
brew postinstall node -v
After the installation of our toolset is complete, you can either clone or download a .zip of our repository. To download the zip, click on this link: https://github.com/kennanmell/Handoff/archive/master.zip Run the following command to clone the repository:
git clone https://github.com/kennanmell/Handoff.git
While we hope to have an executable as an .apk file in the future, currently the best working method to run our software is through the command line and an emulator from Android Studio.
Once in the cloned directory, run the command "npm install". Open an emulator from Android Studio. This can be done by opening Android Studio, opening/creating a new project, and then clicking the icon that says Android AVD if you hover over it. It is located on the top toolbar of Android Studio, and the icon looks like a phone screen.
In the original command line, run "react-native run-android". This will pop open a third command line instance - ignore this. This will run for a long time the first time you run it. When it's finished look at your emulator, it might take a minute to load but the app should pop up there, and then you can use the app.
Frequent Errors: There are some issues with finding the paths to the Android Libraries. To resolve this, be sure to export the following:
Your paths to Android/sdk, Android/sdk/tools, and Android/sdk/platform-tools, which will depend on where they were installed, as well as using the command
export PATH=${PATH}:${ANDROID_HOME}:${ANDROID_TOOLS}:${ANDROID_PLATFORM_TOOLS}
If you don't want to do that every time, you can add these commands to your environment variables. To open this file from the command line, "open ~/.bash_profile" then "source ~/.bash_profile". If the file does not exist, you should create it first.
Another Error: If there are further errors running the program, you made need to change the permissions on a file in the Android folder. When in the Handoff directory, cd into the Android folder. From there run the following command:
chmod 755 gradlew
There are two seperate users for our app, one representing an organization and one representing a community member.
As of the zero feature release, the app has no functionality and the only thing you can do with the application is to type in a textbox. However, for the future the following explains how to use our software.
Organization: Upon logging in using their organizations username/password, the app will display a Create Request button will take the user to a display where they can title their request, add keywords, and add a description, and then post the request to our request database. The organization should also have all the functionality of the community member. Organizations will be given a username/password by us until we design an automatic authentication system.
Community Member: Users can log in through connecting Handoff to their Facebook. They can then select to view organization's requests either through a feed or a map and switch between them by pressing the button that represent the mode that the user is not already using. Alternatively, they can search for specific keywords through or search feature. Once they find an organization through some method, they can click on that organizations name to be taken to the organizations page, which the user can then subscribe to.
To report a bug go to this webpage: https://github.com/kennanmell/Handoff/issues/new Please note that you must log in to a Github account to report a bug. If you do not have one, I would make one.
We would ask that any bug report contain certain information:
Overview (Most of this format is taken from Oracle's How to Write a Helpful Bug Report):
---- a synopsis of the overall bug; basically a title
---- a more detailed description that talks about the issue and a potential solution to it.
Routing Information:
---- Category: As specific information as to what component displayed this issue.
---- Version: The release of the product that the bug was experienced on.
---- Regression version: What version did not have this issue.
---- Severity: Indicate the severity of the issue.
Test Case: Give as much info as possible of the situation of the test case
---- Operating system/ Hardware: specify the platform
---- Steps to reproduce: Outline steps to reproduce this problem.
---- Expected result: What should have happened if no bug was present
---- Actual result: What did happen given this test case
Contact Information
---- Information that will allow us to contact you to either clarify some information in the bug report or provide an update