Skip to content
/ Hop Public

Hop puts the café you need, in your hands.

Notifications You must be signed in to change notification settings

xhxh96/Hop

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

55 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hop

Hop is an iOS mobile app that assists users in looking for the cafés that they need. Users are able to search for cafés either using keyword or via location.

The key features of the app are posting of reviews for cafés and updating of café information such as address and amenities.

Getting Started

The app is fully written in Swift 4.1, targeted to run on iOS 11.4, although the app should work for any iOS devices running iOS 9.0 and above.

The app is however not universal and is thus not officially supported on iPad.

Backend system of this mobile app is running on MongoDB + NodeJS and managed by @elstonayx. For updates and development of the backend system, please access the GitHub repo here

Note: The client_id and client_secret in NetworkController.swift have been revoked for security purposes. To get the search working, you would have to input your own Foursquare client_id and client_secret.

Prerequisites

  • iOS device running iOS 9.0 and above

User Guide

The mobile app can be used with and without an account being created (guest mode).

Creating an Account

Account can be created by selecting Sign In, followed by Create an Account.

Account details are stored in our backend server, with the password being hashed via bcrypt.

User Profile

User Profile can only be accessed after user has logged in via the main page.

Under User Profile, user can edit the profile information and view all the reviews submitted.

Review management is also done using the User Profile page.

Café Search

To begin a café search, select the search bar in the main page.

User will then be brought to the search result table. By default, the results will show cafés that are near the user.

Selecting the café in the search result will bring user to the café page.

Café Page

The café page provides users with a systematic view of the general information such as address and operating hours. It also provides users with the available amenities (such as free WiFi, being situated near a public transit etc) as well as reviews from verified users and food bloggers.

Reviews from food bloggers are scrapped using GoogleSearch API.

Users are also able to submit a review for the café by selecting the Submit Review option, or update the amenities available by selecting the Update at the bottom of the page.

Deployment

Deployment of the backend system can be found in the backend server repo.

Built With

  • XCode 9.4.1
  • Swift 4.1
  • Carthage - Dependency Management (Version 3.4 and prior)
  • Cocoapod - Dependency Management (Version 3.5 onwards)

Third-Party Dependencies:

Versioning

Git

Authors

  • Cheng Xianhao - Front-End Developer - xhxh96
  • Elston Aw - Back-End Developer - elstonayx

Acknowledgments

About

Hop puts the café you need, in your hands.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published