To-Do service API

To-do list

What’s the to-do list?

This to-do list is a REST API that allows you to manage upcoming and ongoing tasks, along with reminders for high priority tasks. By sharing this API with other people, such as friends or family members, you can also create a joint to-do list with shareable tasks and reminders.

How does this all work?

Any user with access to the API can add a task to the cloud-hosted to-do list, including specific details such as the task assignee and when the task should be complete by. All users with access to the API can view this information and freely edit the tasks as necessary, such as shifting a reminder’s time or adding information to a task.

Features

• Adding tasks
  • Modifying existing tasks
  • Setting reminders
• Enrolling users
  • Deleting existing users

To-do list prerequisites

• A GitHub account
• A development system running a current version or a long-term support, also known as LTS, version of the Windows, MacOS, or Linux operating system.
• The following software on your development system:
  • Git, command line
  • Optionally, GitHub Desktop.
  • A fork of the To-Do-Service repository
  • A current or LTS version of node.js
  • Version 0.17.4 or later of json-server
  • A current copy of the database file. You can get this by syncing your fork.

For information about testing the API, see Test your development system.

Contributing to the API

You can submit a pull request for review to update the existing API documentation for the to-do list. This can include bug fixes, code changes, proposing a new feature, or just maintaining out-of-date resources. To contribute, follow the steps below:

1. Fork this repository to your GitHub account.
2. Confirm you can build a local copy of the documentation from your fork.
3. Install Vale on your development or editing computer. To help you have a successful pull request experience, it’s also helpful to add these extensions if you edit with the following assistants:
   • Markdownlint
   • Vale
4. A successful pull request:
   • Must not require more content in order for your pull request to work
   • Must help the end user of the product
   • Must have no lint or Vale errors
   • Must have no errors in any code examples
5. Test your changes locally from your feature branch before submission.

---

More Information

This work is for the APIDOC 310 course at the University of Washington.

`

This site is open source. Improve this page.