Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
georgiamshaw authored Sep 13, 2019
1 parent e4516f7 commit c01c123
Showing 1 changed file with 56 additions and 83 deletions.
139 changes: 56 additions & 83 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,85 +1,58 @@
# Meet me in the middle
Initial idea [Where should we meet? #7](https://github.com/fac-17/student-project-ideas/issues/7#issue-475546550)
## Overall and solutions/inspirations
![](https://i.imgur.com/xJ861yL.png)
![](https://i.imgur.com/dKNKF8o.png)

## User Journeys
### Main User Journey
As a user, I want to find a convenient, suitable place to meet my friend in
an easy and unanimous way.

### Supporting User Journey
- As a user, I want to understand what this app is doing.
- As a user, I want to be able to create an event that suits the occasion.
- As a user, I want to be able to invite the person I'm meeting to the app.
- As a user, I want to find a location that is half way between me and my friend(s).
- As a user, I want to be shown my travel and arrival time.
- As a user, I want to be given a variety of venue options to choose from.
- As a user, I would like to be able to filter my results to fit my budget.
- As a user, I want to choose between different route/transport options to get to the venue.

### User Stories
**Onboarding Page**
- As a user, I want the onboarding to be concise and understandable.
- As a user I want to see a description of the app and be guided through the steps where necessary
- As a user, I want a button to take me to the next section quickly

**Event Creation Form (user A)**
- As a user, I want to select the occassion (date, friends, work)
- As a user, I want to be able to input time and date
- As a user, I want to select the vibe/style of the meeting venue
- As a user, I want to be able to input my location either by postcode or have the app automatically pick my location(gps)
- As a user, I want to be able to know if I filled in the form correctly, and receive a notification if it was incorrect.
- As a user, If my even form was submitted correctly, I want to see confirmation that my event was created, and only then see a link to share my event.
- As a user, I want to have a clear and simple way to share the event with my friend.

**Location Input Form (user B)**
- As a user, I want to get the event information provided by user A
- As a user, I want to know why I am asked to provide my postcode
- As a user, I need to be able to input my postcode
- as a user, i need to validate my form when i'm done
- As a user, I want to be able to change my departure location after confirmation

**Location/Venue choices**
- As a user, I want to be able to browse my options without having to make a decision straight away.
- As a user, I want to be able to find out more information about every option.
- As a user, I want to pick the options I like.
- As a user, I want to remove the options I don't like.
- As a user, I only want to be asked once for my prefered location/venue
- As a user, I want to validate my choices

**Final Venue Confirmation (chosen by app) and Route suggestions**
- As a user, I want to be notified as soon as a venue has been selected by the computer
- As a user, I want to be able to see more information about the venue
- As a user, I want to compare the price and travel/departure time of different route options
- As a user, I want to select between different types of transport
- As a user, I want to be able to click on any route to see more info.

**Route Description**
- As a user, I want to see a step by step route description
- As a user, I want to be able to go back and view other routes.
- As a user, I want to be able to go back to choose another route option

### Things we need to scope/learn
- How to send native notifications
- How to add swiping to our code (both for multi page form and venue selection)
- How to add tapping to our code
- Yelp API
- TFL API
- Google maps/any other map API
- Card animation while moving from one page to another
- How to copy a link to user's clipboard when clicking a button
- How to share a link inside an app(social media sharing)

## Roles:
UX/UI - Reuben (assist by Sarah)
DevOps - Leonie (assist by Georgia)
Scrum - Sarah (assist by Leonie)
QA - Georgia (assist by Reuben)

## Stretch Goals
- Add events to calendar.
- Link to functional mapping app.
- repo -> ThinkBig-OutlinesOfAppImpact.md
- Autofill

## Team

- [@laleonie](https://github.com/LaLeonie) - DevOps Lead
- [@sarahyjja](https://github.com/sarahyjja) - Scrum Master
- [@reubengt](https://github.com/reubengt) - UX/UI Lead
- [@georgiamshaw](https://github.com/georgiamshaw) - QA Lead

## Getting started

git clone [email protected]:fac-17/Where-Should-We-Meet.git

cd Where-Should-We-Meet

npm i

touch .env

Then add your Yelp API key to your ```.env``` file like this:

YELP_API_KEY=[YOUR API KEY HERE]

To run the project locally:

npm start

## Our problem

Imagine this: your friend Chris lives in Mile End, and you live in Imperial Wharf. This journey takes you over an hour, but for Chris, it's just a fifteen minute walk to Brick Lane, where you're meeting.

Today is the third time in a month that you've made this journey to see Chris, because Chris thinks Brick Lane "is just, so cool" and he doesn't want to travel "all that way" to your part of London, where there's "not even anything to do".

And, well, you can't really argue with Chris because you can't think of anywhere else to meet that cuts both journey times and is, well, "so cool".

Wouldn't it be wonderful to have an app that allows you to input two postcodes, and in return gives you loads of great venues to meet at? Venues in the middle of both of you?

## Main user journey

As a user, I want to find a convenient, suitable place to meet my friend in an easy and unanimous way.

## Tech stack

- CSS
- Express
- Node.js
- Javascript
- Travis
- Heroku

## What we've done so far


## What we still need to do


## What we're unsure of

0 comments on commit c01c123

Please sign in to comment.