Skip to content

Latest commit

 

History

History
207 lines (149 loc) · 6.94 KB

README.md

File metadata and controls

207 lines (149 loc) · 6.94 KB
Raw

Fwitter Group Project

Objectives

  1. Build a full scale Sinatra application that uses:
  • A sqlite database
  • ActiveRecord
  • RESTful routes
  • Sessions
  • Login/Logout

Overview

The goal of this project is to build Fwitter (aka Flatiron Twitter).

You'll be implementing Fwitter using multiple objects that interact, including separate classes for User and Tweet.

Just like with Twitter, a user should not be able to take any actions (except sign-up), unless they are logged in. Once a user is logged in, they should be able to create, edit and delete their own tweets, as well as view all the tweets.

There are controller tests to make sure that you build the appropriate controller actions that map to the correct routes.

Group Project Instructions

Instructions for how to work on a Group Project

Some Hints on Working Together

Working on a software project with another person is not something to be taken lightly. While you are a fantastic coder solo, software development is a collaborative activity. Just like anything else, there is skill in collaborating on code. In the end, collaborating with another person boils down to three different styles:

  • Pair - Pair the entire time working linearly together
  • Pass - 1 person does 1 requirement and then the next person does the next one
  • Parallel - work on different parts at the same time by agreeing on interfaces and stubs and meeting in the middle

Remember! The goal at The Flatiron School is not to do, it is to learn. Make sure you have worked in all three styles of collaboration. We want you to learn how the different styles work, and make sure that together you and your partner understand every part of the code.

Instructions

File Structure

├── CONTRIBUTING.md
├── Gemfile
├── Gemfile.lock
├── LICENSE.md
├── README.md
├── Rakefile
├── app
│   ├── controllers
│   │   ├── application_controller.rb
│   │   ├── tweets_controller.rb
│   │   └── users_controller.rb
│   ├── models
│   │   ├── tweet.rb
│   │   └── user.rb
│   └── views
│       ├── index.erb
│       ├── layout.erb
│       ├── tweets
│       │   ├── new.erb
│       │   ├── edit_tweet.erb
│       │   ├── show_tweet.erb
│       │   └── tweets.erb
│       └── users
│           ├── create_user.erb
│           └── login.erb
│           └── show.erb
├── config
│   └── environment.rb
├── config.ru
├── db
│   ├── development.sqlite
│   ├── migrate
│   │   ├── 20151124191332_create_users.rb
│   │   └── 20151124191334_create_tweets.rb
│   ├── schema.rb
│   └── test.sqlite
└── spec
    ├── controllers
    │   └── application_controller_spec.rb
    ├── models
    │   └── user_spec.rb
    └── spec_helper.rb

Gemfile and environment.rb

This project is supported by Bundler and includes a Gemfile.

Run bundle install before getting started on the project.

As this project has quite a few files, an environment.rb is included that loads all the code in your project along with Bundler. You do not ever need to edit this file. When you see require_relative ../config/environment, that is how your environment and code are loaded.

Models

You'll need to create two models in app/models, one User model and one Tweet. Both classes should inherit from ActiveRecord::Base.

Migrations

You'll need to create two migrations to create the users and tweets tables.

Users should have a username, email, and password, and have many tweets.

Tweets should have content and belong to a user.

Associations

You'll need to set up the relationship between users and tweets. Think about how the user interacts with the tweets, what belongs to who?

Home Page

You'll need a controller action to load the home page. You'll want to create a view that will eventually link to both a login page and signup page. The homepage should respond to a GET request to /.

Tweets Index Page

You'll need to create a controller action that will load the tweets index page. You'll want to create a view that will display all tweets for the logged in user and other users. The tweets index page should respond to a GET request to /tweets. If a user is not logged in, it will redirect to /login.

Create Tweet

You'll need to create two controller actions, one to load the create tweet form, and one to process the form submission. The tweet should be created and saved to the database. The form should be loaded via a GET request to /tweets/new and submitted via a POST to /tweets.

Show Tweet

You'll need to create a controller action that displays the information for a single tweet. You'll want the controller action to respond to a GET request to /tweets/:id.

Edit Tweet

You'll need to create two controller actions to edit a tweet: one to load the form to edit, and one to actually update the tweet entry in the database. The form to edit a tweet should be loaded via a GET request to /tweets/:id/edit. The form should be submitted via a POST request to /tweets/:id.

You'll want to create an edit link on the tweet show page.

Delete Tweet

You'll only need one controller action to delete a tweet. The form to delete a tweet should be found on the tweet show page.

The delete form doesn't need to have any input fields, just a submit button.

The form to delete a tweet should be submitted via a POST request to tweets/:id/delete.

Sign Up

You'll need to create two controller actions, one to display the user signup and one to process the form submission. The controller action that processes the form submission should create the user and save it to the database.

The form to sign up should be loaded via a GET request to /signup and submitted via a POST request to /signup.

The signup action should also log the user in and add the user_id to the sessions hash.

Make sure you add the Signup link to the home page.

Log In

You'll need two more controller actions to process logging in: one to display the form to log in and one to add the user_id to the sessions hash.

The form to login should be loaded via a GET request to /login and submitted via a POST request to /login.

Log Out

You'll need to create a controller action to process a GET request to /logout to log out. The controller action should clear the session hash, and redirect the user to /login.

Protecting The Views

You'll need to make sure that no one can create, read, edit or delete any tweets unless they're logged in.

You'll want to create two helper methods current_user and logged_in?. You'll want to use these helper methods to block content if a user is not logged in.

It's especially important that a user should not be able to edit or delete the tweets created by a different user. A user can only modify their own tweets.