Skip to content

Commit

Permalink
Merge pull request #4 from FACN1/update-readme
Browse files Browse the repository at this point in the history
#2 update read me with user stories
  • Loading branch information
HilbertSpitzer authored Apr 11, 2017
2 parents fefa274 + c34b50e commit c21d665
Showing 1 changed file with 33 additions and 6 deletions.
39 changes: 33 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Our site will be a blog about what was cooked for dinner at the guesthouse (or e


## User Stories
#### WEEK 7 USER STORIES
**As a bored internet browser who navigates to the home page:**
> I want to see a list of posts about different dinners which were cooked
Expand All @@ -25,11 +26,40 @@ Our site will be a blog about what was cooked for dinner at the guesthouse (or e
> So that I can re-read the post with my friends at various points in the future and laugh and be merry
#### WEEK 8 USER STORY

**As a member of Founders and Coders, who wants to learn about the dinners being cooked up at the guesthouse**

> I want to log in with my Github account
> So that I can securely and privately access secret dinner activities occurring within the FaCN1 community.
** Acceptance Criteria**

- [ ] I can click on a button, which allows me to log in via my Github account

- [ ] The look of the button should make it obvious that it is this form of login

- [ ] Once I'm logged in, I should see a list of blog posts

- [ ] I shouldn't be left with a blank loading screen for too long during the authorisation process, otherwise I will lose confidence in your website and leave.

**As any user who is logged in to the Guesthouse Dinners Blog**

> I want to see my username & Github profile picture on the homepage
> So that I benefit from logging in with Github OAuth, and don't have to do any profile setup on your site.
**Acceptance criteria**

- [ ] I can see my username & profile picture on each page that I visit


## Local install instructions
- In your command line run:

```bash
git clone https://github.com/FACN1/week7-SPN.git
git clone https://github.com/FACN1/week8-edjy.git

cd week7-SPN

Expand All @@ -41,9 +71,9 @@ atom config.env

- SAVE the config.env file

- Ask us for the DB_URL (on gitter)
- Ask us for the DATABASE_URL (on gitter)

- Enter DB_URL within config.env in your text editor.
- Enter DATABASE_URL within config.env in your text editor.


## Database Schema:
Expand All @@ -58,6 +88,3 @@ background_color | character varying(25) | not null |
date_published | timestamp without time zone | not null default now() |

## Stretch Goals
- Add chefs db table(/user logins)
- Add comments db table (i.e. comments on posts)
- Add search/filter options to index page

0 comments on commit c21d665

Please sign in to comment.