Giter VIP home page Giter VIP logo

taskydo's Introduction

Taskydo

...ensuring you meet task's deadlines for improved productivity

Introduction

Taskydo Taskydo is a leading to-do application that provides you with a seamless service to properly manage your tasks for productivity. Staying organised is very key to meeting up with targets and being efficient in fixing and getting things done.Therefore, Taskydo has been carefully engineered to feature top notch micro services and tools for you to have the best experience which consequentlly put you on top of your tasks.

Among other features are an optimization system such as catching, security techniques such as authentication and rate limiting and also is an email notification system that sends you a reminder through your registered email address just about an hour to the due time of a created task. A relational database is used as data storage to enhance future growth.

Taskydo is indeed the answer to a cluttered set of activities that leads to missing deadlines. Read the full documentation Here to get the endpoints details.

Getting started (signing up):

  1. You need to enter a userName, password and a unique email as a JSON object to open an account with Taskydo .
  2. Your password should not be less than 8 characters.

Authentication and Authorization

  1. After signining up,users must login to make all the task related requests.e.g task creation, task updating, task filtering e.t.c. This is because the system authenticate and authorize users before a request is allowed.
  2. A Jwt token is generated when a user Login. The token stores encrypted details of the user in the client's cookie storage to authenticate and authorize the user when making request to the API. The Jwt token expires after 2hrs. Meaning, users will be authomatically logged out after 2hrs for security reasons.
  3. To login, use the correct email and password as used when signing up. Else, you will get an error message.

Creating a task

  1. To create a task (i.e your to-do), user need to enter the title, description and a due_date as a JSON object.
  2. The due_date must be in the format yyyy-mm-ddTHH:MM:ssZ e.g 2024-08-10T14:30:00Z (i.e 10th August, 2024 at 2:30PM)
  3. Every task is created with a default status , "Pending"

Retreiving task/tasks:

When a task or tasks are retrieved , the response object for each task contains a unique URL to update its status as "Completed" or "Pending" depending on the current status and also contains a unique URL to also delete the task if desired.Retrieved tasks or filtered tasks are paginated. So you can view the next page by adding the query parameter ?page= . E.g ?page=2

Filtering tasks:

  1. Completed tasks can be filtered out by adding the query parameter, ?status=Completed to the filtering endpoint .
  2. Pending tasks can also be filtered out by adding the query parameter, ?status=Pending to the filtering endpoint .

Updating a task:

  1. The title, description and a due_date of tasks can be updated. The update should be sent as JSON object just like when creating a task.
  2. The endpoint to update a task can be found in the response object of retreived task with an attached id as a path parameter.

Deleting a task:

  1. The response object of every retrieved task contains the field that stores the endpoint to delete the retrieved task.
  2. The endpoint to delete a task can be found in the response object of retreived task with an attached id as a path parameter.

Key Notes:

  • It is advisable you later delete completed tasks to free the memory.
  • All responses are JSON objects.
  • When done, ensure you Logout from the system for security reasons.
  • Excessive or too many requests to the API is prevented with a rate limiting tool.
  • Read the full documentation Here to get the endpoints details.

Stay in touch

taskydo's People

Contributors

sulaimon-rasheed avatar

Watchers

 avatar

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.