Skip to content

logangirvin/choreboard

Repository files navigation

ChoreBoard

Choreboard is a web application used to manage chores in a large-ish household using Go and vanilla Javascript.

ChoreBoard is designed to be run on a private network, where users/housemates are able to report chores that need to be done, and the service will notify other users/housemates that there's work to-do. ChoreBoard will track and report various metrics of users like chores completed, chores skipped, etc, and compare users with each other in an effort to drive competition in the house (to be the least shitty roommate).

Installation

  1. Install Go

  2. Setup a Go workspace (How to Write Go Code)

  3. Clone this repository into the src folder of your Go workspace

  4. Resolve dependencies

    $ go get github.com/emirpasic/gods/sets/hashset
  5. Start up the service

    $ go run $GOPATH/src/choreboard/controller/ChoreController.go

From there, you should have the service running on localhost:8080.

  1. Install your favorite web server (ex. Nginx)
  2. Configure your server's root directory to the clone you just made (jank AF)
  3. Go to your favorite web browser and go to the server's IP

NOTE: As of now, only certain users are allowed to log into the service, and new users cannot be created.

About

website to be hosted on a raspberry pi to manage and notify housemates of responsibilities.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors