hannah-frost / acebook-isambard Goto Github PK

View Code? Open in Web Editor NEW

This project forked from makersacademy/acebook-rails-template

2.0 1.0 3.0 6.24 MB

Template for the AceBook project

License: Other

Ruby 68.44% JavaScript 1.84% CSS 7.91% HTML 21.81%

acebook-isambard's Introduction

AceBook

This project uses Ruby Rails, Capybara, RSpec and databases to create the foundations of a social media app.

This is the engineering project outline.

How to View and Use App

Clone this repository.
Run bundle install in your command line to install all gems in the Gemfile.
Run bin/rails db:create in your command line to create the required databases.
Run bin/rails db:migrate in your command line to create the required tables in the databases.
You can view through the url http://localhost:3000/ by running bin/rails server in the command line to start the server.
You can also view through https://acebook-isambard.herokuapp.com/ (recommended).

How to Run Tests

bundle exec rspec in the command line will run the RSpec / Capybara tests.

Model View Controller

User Stories

USER SIGN-UP

As a user,
so that I don't forget to sign up,
I am redirected to a sign up page unless already signed up.

As a user,
so that I know which details are required when signing up,
I am prompted to enter a email and password.

As a user,
so that I know if my email is valid,
I see a helpful message explaining if my email is not valid.

As a user,
so that I know if my password is valid,
I see a helpful message highlighting the required length of 6-10 characters.

As a user,
so that I know I have signed up successfully,
I want to be redirected to my posts page with a sign up confirmation message.

USER SIGN-IN

As a user,
so that I don't forget to log in,
I am redirected to the index page unless already logged in.

As a user,
so that I can log in,
I can see a 'log in' link which redirects me to a log in page where I am prompted to enter an email and password.

As a user,
so that I know I have entered my email correctly,
I should receive an error message if my email is invalid.

As a user,
so that I know I have logged in successfully,
I want to be redirected to my posts page.

POSTS

As a user, 
so that I can keep up-to-date with the latest feed, 
I want to see the most recent posts first.

As a user, 
so that I can format my posts, 
I want to have the ability to add new lines to posts.

As a user, 
so that I can see when posts were submitted, 
I want to see date that they were created.

As a user, 
so that I can have no regrets, 
I want to delete posts.

As a user, 
so that I can have no regrets, 
I want to update posts.

As a user, 
so that I can interact with friends, 
I want to comment on their posts.

As a user, 
so that I can show my approval, 
I want to like posts / comments via an emoji button.

As a user, 
who will soon have no friends, 
I want to see the number of likes next to the like emoji.

As a user, 
so that I don't spam my friends with likes, 
I want to be able to like each post / comment only once.

As a user, 
so that I have a seamless user experience, 
I want the browser not to refresh when liking posts / comments.