/ChoreSplitter-Old

Deprecated version of ChoreSplitter (see updated repo)

Primary LanguageJavaGNU General Public License v3.0GPL-3.0

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

ChoreSplitter!

A web application to split chores with roomates!
Explore this website »

Visit Wiki · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. License
  5. Contact
  6. Acknowledgments

About The Project

Product Name Screen Shot

ChoreSplitter was designed as an easy and fun way to "gamify" the process of completing chores. 87% of all college students have one or more roomates, and often times these roomates are chosen at random by the school they attend. This means students may often get roomates that don't pull their weight around the dorm or apartmemt. With ChoreSplitter, you and your roomates can compete to complete as many chores as possible, ranking up on a public leaderboard for everyone to see. We hope it will revolutionize the way you and your roomates get chores done!

Here's why:

  • Completing chores should be fun, and ChoreSplitter turns the process into a video game.
  • A public leaderboard gives roomates a social incentive to pull their weight.
  • You can chat with all your roomates right in the app.

(back to top)

Built With

Below is a comprehensive list of the frameworks, libraries, and languages used to build ChoreSplitter.

(back to top)

Getting Started

To get a local copy of ChoreSplitter up and running, follow these simple steps.

Prerequisites

You must have Java 16 and an Apache Tomcat v10.0.6 server installed and running

Installation

Below are the necessary steps needed to run this project. All additional dependencies can be accessed from the pom.xml.

  1. Clone the repo 
    git clone https://github.com/TechnoVisionDev/ChoreSplitter.git
  2. Create a free MongoDB cluster at https://www.mongodb.com
  3. Add your cluster URI as an environment variable 
    DATABASE="insert-mongodb-uri";

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the GNU GPLv3 License. See LICENSE.txt for more information.

(back to top)

Contact

Thomas Peters - @tomm__peters - tapeters@usc.edu

Project Link: https://github.com/TechnoVisionDev/ChoreSplitter

(back to top)

Acknowledgments

Below are some resources that have been instrumental in making this project a reality!

(back to top)