Git Product home page Git Product logo

chorehound's Introduction

ChoreHound

Simple app to remind people to do their chores.

Architecture

Architecture

API Draft

Draft REST API

CRUD operations for family

TBD: Assume one family per "licensed" user

  • GET /users # Get list of all users for the family (for the authenticated user) - includes the calling user
  • POST /users # Add a user to the family
  • GET /users/[user-id] # Get details of the specified user
  • POST /users/[user-id] # Update details for the specified user
  • DELETE /users/[user-id] # Remove the user from the family (TBD: how to handle if this is the active/primary user??)

TBD: JSON struct for user (includes contact info)

CRUD operations for chores

  • GET /chores # Get list of all chores (for the authenticated user)
  • POST /chores # Create a new chore
  • GET /chores/[chore-id] # Get details of the specified chore
  • POST /chores/[chore-id] # Update details for the specified chore
  • DELETE /chores/[chore-id] # Delete the specified chore

TBD: JSON struct for chore (includes schedule, responsible users)

Schedule-driven operations

  • POST /reminder # Send scheduled reminders; TBD: is this for everything? Should it be chore/user specific??

chorehound's People

Contributors

mark-tucker avatar markrtucker avatar

Watchers

 avatar

chorehound's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.