Implement development README

wilbooorn · Jun 5, 2017 · 2dfa63c · 2dfa63c
1 parent 6f1bef8
commit 2dfa63c
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 22 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -4,6 +4,10 @@ Friends, colleagues, and significant others alike all face a similar problem day
 
 Chowtime is a mobile App built using React Native, that utilizes the Yelp Fusion API to decide on a restaurant for you! Just provide a few search criteria and let Chowtime handle the rest. Don't like the suggestion? It'll give you another one until you do. It even gives you the option to call an Uber straight to the restaurant. Now, deciding what to eat can be as simple as opening an app!
 
+## Functionality & MVP
+
+With this extension, users will be able to:
+
 - [ ] Hosting on The App Store
 - [ ] Geolocation based search
 - [ ] Yelp Fusion API Implementation
@@ -12,22 +16,50 @@ Chowtime is a mobile App built using React Native, that utilizes the Yelp Fusion
 
 ## Wireframes
 
-**Insert wireframe here**
+Pictured below is the home page where a user will be able to enter search criteria, which will be used to find a restaurant.
+
+![Search Page](https://res.cloudinary.com/dslok1mwv/image/upload/v1496635237/Screen_Shot_2017-06-04_at_8.58.43_PM_fmgku5.png)
+
+Below is the results page, which will display a restaurant's information taken from Yelp. Users will have the option to either search for another restaurant or call an Uber to the restaurant.
+
+![Results Page](https://res.cloudinary.com/dslok1mwv/image/upload/v1496635238/Screen_Shot_2017-06-04_at_8.51.06_PM_au4fcj.png)
+
+## Technologies & Technical Challenges
+
+Technologies Used:
+- React Native
+- Yelp Fusion API
+- Uber API
+- XCode
+
+The primary challenges will be:
+- Learning React Native.
+- Converting user's location to latitude and longitude coordinates and passing it to Uber's API.
+- Making Chowtime Android and iOS compatible.
+
+## Things we accomplished this weekend.
+
+1. Research Yelp Fusion API and regulations.
+2. Research Uber API and regulations.
+3. Install and set up React Native.
+4. Research Apple Developer Program.
+5. Start the skeleton of the project.
 
 ## Implementation Timeline
 
-### Phase 1
+**Day 1:** Get started learning React Native. Familiarizing ourselves with components, styles, and ecosystem.
 
-**TBD**
+**Day 2:** Complete layout for initial search page.
 
-### Phase 2
+**Day 3:** Implement Yelp Fusion API given search criteria and store results on the frontend.
 
-**TBD**
+**Day 4-5:** Implement restaurant result page with ability to decline result and display another restaurant.
 
-### Phase 3
+**Day 6:** Implement search again if user declines all restaurant results.
 
-**TBD**
+**Day 7:** Implement Uber ride button, passing in starting and ending coordinates.
 
-### Phase 4
+## Plan for publishing to App Store
 
-**TBD**
+- Purchase Apple Developer license and submit to App Store for review.
+- Once on App store, advertise to friends and family.
diff --git a/docs/component-hierarchy.md b/docs/component-hierarchy.md
diff --git a/index.android.js b/index.android.js
@@ -1,9 +1,3 @@
-/**
- * Sample React Native App
- * https://github.com/facebook/react-native
- * @flow
- */
-
 import React, { Component } from 'react';
 import {
   AppRegistry,

diff --git a/index.ios.js b/index.ios.js
@@ -1,9 +1,3 @@
-/**
- * Sample React Native App
- * https://github.com/facebook/react-native
- * @flow
- */
-
 import React, { Component } from 'react';
 import {
   AppRegistry,
@@ -17,7 +11,7 @@ export default class Chowtime extends Component {
     return (
       <View style={styles.container}>
         <Text style={styles.welcome}>
-          Welcome to React Native!
+          It's Chowtime!
         </Text>
         <Text style={styles.instructions}>
           To get started, edit index.ios.js