Skip to content
A roommate a system that keeps track of your chores, groceries and bills. Create list's yourself and have your roommates check off on what's done.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
bin
config
db
lib
log
public
test
vendor/assets
.gitignore
Gemfile
Gemfile.lock
README.md
README.rdoc
Rakefile
config.ru
spec-js.md

README.md

roommate_assistant

A roommate system that keeps track of your chores, groceries and bills. Create list's yourself and have your roommates check off on what's done.

Blog Post

http://williammena.github.io/2017/03/18/my_rails_project_roommate_assistant/

Getting Started

Prerequisites

  • You must install Bundler using the info here.

Installation

  • Fork & clone repo
  • Run bundle install && rake db:migrate in Terminal

Usage

  • Type rails s in Terminal to run Rails server
  • Visit locahost:3000 in browser to interact with web app

Future Work

  • Implementing 'Bills'. A location where you can maintain your upcoming/previous bills for your group of roommates.
  • Add some math to each individual bill so you can charge a certain percentage to a specific roommates or divide equally between all roommates. (Only mention how much is owed, each instance will have a 'paid_on:' that will hold the date a user claims to pay)

License

This project is licensed under the MIT License.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contribution Guide

We encourage you to contribute RoommateAssistant Project! Look at our 'Future Work' section for things we would like to implement in the future. Or even if you have tests you would like to add or revisions for some code, all would be appreciated.

Checkout the Ruby on Rails guide for ideas about how to proceed.

Acknowledgments

  • Thank you to Steve Frost for readME format
You can’t perform that action at this time.