Skip to content

Latest commit

 

History

History
107 lines (70 loc) · 3.47 KB

README.md

File metadata and controls

107 lines (70 loc) · 3.47 KB
Raw

GRAB BAG

The hottest new way to store and share your files

View it live at: https://grabbag.herokuapp.com/

Setup

To set up a local copy of this project, perform the following:

  • Clone the repository: git clone https://github.com/stovermc/grab_bag
  • cd into the project's directory
  • Run bundle install
  • Run bundle exec rake db:{create,migrate,seed} to set up the database locally and seed it with files, folders, users, and comments
  • To login as an admin (in development), use these credentials - username: admin1, password: password
  • Run the application in the dev environment with rails s
  • Visit http://localhost:3000/ and enjoy

Schema

A visual representation of the schema is here: schema pic

Features (the basic version)

Visitor

  • A visitor is an un-logged in user
  • He can view public folders, and that's about it

User

  • A user can sign up for an account via Facebook or create one manually
  • Regardless of signup method, she must provide a username and phone number for Two Factor Authentication purposes
  • A user can view and edit her details
  • A user can reset her password with a text confirmation (via Twilio)

Admin

  • An admin can make other users into admins, deactivate users, and delete files and folders

Folder

  • Every user is created with a home folder
  • When a new folder is created, its entire path is stored in the database
  • Folders can be created as public or private
  • Folders can be shared by entering another user's email, which sends that user an email invite link

File (in the schema, Binary)

  • Files can be uploaded or downloaded if they belong to that user, or if they are in a folder shared with that user
  • Files can be previewed on the page

Comment

  • A user can leave comments on any file that is owned or shared with him

Like

  • A user can like a comment or a file to which he has access, and can like it as many times as he wants, so feel free to go a bit crazy

Features (the in-depth version)

Visitor

  • some stuff here

User

  • A user is created with a home folder, via a private make_folder method. @user.home will return this folder
  • A user has owned_folders, a relationship through Folder, through the foreign key user_id

Admin

  • some stuff here

Folder

  • Folders have a method children. This includes both other folders and binaries stored in that folder
  • Folders have a method url, which concatenates a complete route by combining the owner.username and the route

Binary (File)

  • Binaries have a url method which builds the url by combining the folder.url, name, and extension

Comment

  • some stuff here

Like

  • Related to Binaries and Comments through a polymorphic association

Design

Contributors

The contributors for this version of grab-bag are:

Mark Stover
Victoria Vasys
Seth Moser
Stephanie Bentley
Danny Radden

The original repo is found at https://github.com/glassjoseph/grab_bag.git; those contributors are:

Joseph Glass
Jonathan Kidd
Sam Landfried
Danny Radden
Brett Schwartz