Skip to content

Latest commit

 

History

History
69 lines (47 loc) · 1.98 KB

README.md

File metadata and controls

69 lines (47 loc) · 1.98 KB
Raw

Chew App

A cross platform mobile application that helps you find, share, and review the best menu items around you

Team

  • Product Owner: Alex Manusu
  • Scrum Master: Derrick Chie
  • Development Team Members: Gary Ye, Michael Junio, Alex Manusu, Derrick Chie

Table of Contents

  1. Usage
  2. Requirements
  3. Development
    1. Installing Dependencies
    2. Running Locally iOS
    3. Running Locally Android
    4. Roadmap
  4. Team
  5. Contributing

Usage

Are you craving for a certain dish? Search for that dish on Chew and you'll get a list of dishes matching your cravings by rating! After the meal, leave a rating and review to let others know what you thought!

Requirements

  • Django
  • PostgreSQL
  • Xcode

Development

Installing Dependencies

From within the ChewApp directory:

sudo npm install -g bower
npm install

From within the server directory:

pip3 install -r requirements.txt

Running Locally iOS

  1. Download Xcode from the Mac App Store
  2. Navigate to the ChewApp.xcodeproj file in the Chew/ChewApp/ios folder
  3. Open it in Xcode and run the project

Running in Development Mode on an Android Device

  1. Follow the setup details listed in the react native documentation
  2. Connect the device that you want to run the app on. Ensure that the device has USB debugging enabled
  3. Navigate to the Chew/ChewApp folder
  4. Run the following command react-native run-android
  5. If the device is reporting that it cannot connect to the server, type this command adb reverse tcp:8081 tcp:8081 and reload JS in the application

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.